Riot: Wie gehe ich mit API-Änderungen um?

Erstellt am 3. Juni 2016  ·  6Kommentare  ·  Quelle: RIOT-OS/RIOT

Derzeit werden einige (nicht alle) unserer API-Änderungen in der Mailingliste angekündigt und einige (nicht alle) in den Versionshinweisen erwähnt.

Gibt es eine Möglichkeit dies zu optimieren?

Ideen:

  • _alle_ der API-Änderungen müssen auf der Mailingliste bekannt gegeben werden, mit einem klaren Betreff ("API CHANGE in foo_bar()" und einem Nachrichtentext, der erklärt, wie man Legacy-Code repariert,
  • wir eine Datei API_CHANGES im Repo erstellen und alle API-ändernden Commits die obigen Informationen enthalten?

Oder belassen Sie es so wie es ist - versuchen Sie, die Menge irgendwie vernünftig zu informieren?

RFC stale
Quelle
picture kaspar030

Alle 6 Kommentare

Ich bin mir nicht sicher, ob wir die Datei brauchen, aber die Ankündigungen an die Mailingliste sind sicherlich eine gute Idee.

miri64 picture miri64 am 3. Juni 2016

(Andererseits hoffe ich, dass wir bald an einen Punkt kommen, an dem API-Änderungen eher selten vorkommen ;-))

miri64 picture miri64 am 3. Juni 2016

Optimist. ;-)

OlegHahm picture OlegHahm am 3. Juni 2016

Ich würde vorschlagen, APIs zu versionieren, damit Benutzer einer API zur Kompilierzeit benachrichtigt werden, wenn sie ihren Code aufgrund einer API-Änderung aktualisieren müssen.

dh etwas in der Art von (mein Nachsicht - ungetestet):
my_api.h

#define MY_API_VERSION 4711
#if MY_API_VERSION_USED != MY_API_VERSION
#error my_api version does not match used version
#endif
...

usercode.c

#define MY_API_VERSION_USED 23
#include "my_api.h"
...
LudwigKnuepfer picture LudwigKnuepfer am 4. Juni 2016
👎2 👍1

Dieses Problem wurde automatisch als veraltet markiert, da es in letzter Zeit keine Aktivität hatte. Es wird geschlossen, wenn keine weitere Aktivität stattfindet. Wenn Sie möchten, dass ich dieses Problem ignoriere, markieren Sie es bitte mit dem Label "Zustand: nicht veraltet". Vielen Dank für Ihre Beiträge.

stale[bot] picture stale[bot] am 10. Aug. 2019
  • Mailinglisten werden jetzt über API-Änderungen benachrichtigt
  • keine Aktivität in der Diskussion für technische Maßnahmen

vorerst schließen.

kaspar030 picture kaspar030 am 19. Aug. 2019
War diese Seite hilfreich?
0 / 5 - 0 Bewertungen

Verwandte Themen

miri64 picture miri64  ·  3Kommentare
jia200x picture jia200x  ·  5Kommentare
chrysn picture chrysn  ·  5Kommentare
jdavid picture jdavid  ·  5Kommentare
kaspar030 picture kaspar030  ·  3Kommentare