Riot: comment gérer les changements d'API ?

Créé le 3 juin 2016  ·  6Commentaires  ·  Source: RIOT-OS/RIOT

actuellement, certains (pas tous) de nos changements d'API sont annoncés sur la liste de diffusion, et certains (pas tous) sont mentionnés dans les notes de version.

Y a-t-il un moyen d'optimiser cela?

Idées :

  • _tous_ les changements d'API doivent être annoncés sur la liste de diffusion, avec un sujet clair ("CHANGEMENT D'API dans foo_bar()" et un corps de message expliquant comment corriger le code hérité,
  • nous créons un fichier API_CHANGES dans le référentiel, et tous les commits de changement d'API contiennent les informations ci-dessus ?

Ou le garder tel quel - essayer d'informer raisonnablement la foule d'une manière ou d'une autre ?

RFC stale

Tous les 6 commentaires

Je ne suis pas sûr que nous ayons besoin du fichier, mais les annonces sur la liste de diffusion sont certainement une bonne idée.

(d'un autre côté, j'espère que nous arrivons bientôt à un point où les changements d'API sont quelque chose qui arrive assez rarement ;-))

Optimiste. ;-)

Je suggérerais de versionner les API afin que les utilisateurs d'une API soient avertis au moment de la compilation lorsqu'ils doivent mettre à jour leur code en raison d'un changement d'API.

c'est-à-dire quelque chose du genre (supportez-moi - non testé):
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"
...

Ce problème a été automatiquement marqué comme obsolète car il n'a pas eu d'activité récente. Il sera fermé si aucune autre activité ne se produit. Si vous voulez que j'ignore ce problème, veuillez le marquer avec l'étiquette "État : ne pas émousser". Merci pour vos contributions.

  • les listes de diffusion sont maintenant informées des modifications apportées à l'API
  • aucune activité sur la discussion pour les mesures techniques

fermeture pour le moment.

Cette page vous a été utile?
0 / 5 - 0 notes