From 804a73dfd3a0d0283e5b32029d0b3b5e2a32e400 Mon Sep 17 00:00:00 2001 From: Alain BKR Date: Sun, 30 Apr 2023 20:46:23 +0200 Subject: [PATCH] update template for gitrev --- bootstrap/fc_gitrev_gen.h.tmpl | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/bootstrap/fc_gitrev_gen.h.tmpl b/bootstrap/fc_gitrev_gen.h.tmpl index f52d207d6..fd615cce0 100644 --- a/bootstrap/fc_gitrev_gen.h.tmpl +++ b/bootstrap/fc_gitrev_gen.h.tmpl @@ -11,21 +11,35 @@ GNU General Public License for more details. ***********************************************************************/ -/* common/fc_gitrev_gen.h is automatically generated from - * bootstrap/fc_gitrev_gen.h.tmpl. Do not edit fc_gitrev_gen.h, edit - * fc_gitrev_gen.h.tmpl */ +/* DO NOT edit common/fc_gitrev_gen.h, edit fc_gitrev_gen.h.tmpl + * + * fc_gitrev_gen.h is automatically generated + * by bootstrap/generate_gitrev.sh + * from bootstrap/fc_gitrev_gen.h.tmpl + */ #ifndef FC__FC_GITREV_H #define FC__FC_GITREV_H /* One of the macros FC_GITREV_OFF, FC_GITREV_ON or FC_GITREV_MOD defined. - * If FC_GITREV_ON is defined, FC_GITREV2 contains valid git commit id - * string. - * If FC_GITREV_MOD is defined, this seems to be modified git commit. - * In that case FC_GITREV1 contains word "modified " and FC_GITREV2 - * commit id string. + * + * If FC_GITREV_ON is defined, + * FC_GITREV1 contains "origin/S3_1 9c68c0843" + * - a string "origin/current_branch" + * - git commit id corresponding to latest commit from origin. + * + * FC_GITREV2 contains "HEAD a96adce7b (+6)" + * - a string "HEAD" + * - git commit id corresponding to HEAD + * - followed by (+number) of local commit since FC_GITREV1. (+6) in our example + * - optionnally followed by the "modified" word if there are local uncommited changes + * (FC_GITREV_MOD is defined). + * * If FC_GITREV_OFF is defined, you should not use FC_GITREV1 and - * FC_GITREV2 even though they contain fallback string (currently "dist") */ + * FC_GITREV2 even though they contain fallback string (currently "dist") + * + * (Read bootstrap/generate_gitrev.sh for more details) + */ #define FC_GITREV_ #define FC_GITREV1 "" #define FC_GITREV2 "" -- 2.34.1