advice.c: generate "struct advice_setting" from advice.txt

Have generate-advicelist.sh generate the enum label to configuration
key mapping used in advice.c, instead of needing to manually maintain
the *.txt and *.c versions in sync with one another.

As preceding and subsequent commits adding missing documentation show
hoping that we can maintain a 1=1 mapping between the two hasn't been
going well, by generating the file we ensure that we won't make those
mistakes again.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>

Author: avar

.gitignore

@@ -190,6 +190,7 @@
 /gitweb/gitweb.cgi
 /gitweb/static/gitweb.js
 /gitweb/static/gitweb.min.*
+/advice-config.h
 /advice-type.h
 /config-list.h
 /command-list.h

Makefile

@@ -932,6 +932,7 @@ REFTABLE_TEST_LIB = reftable/libreftable_test.a
 # Generated headers. The "COMMON_GENERATED_H" will be added as
 # implicit dependencies on fresh builds (without existing dep/*.mak
 # files)
+GENERATED_ADVICE_H += advice-config.h
 GENERATED_ADVICE_H += advice-type.h
 
 COMMON_GENERATED_H += $(GENERATED_ADVICE_H)

advice.c

@@ -1,4 +1,6 @@
 #include "cache.h"
+#include "advice.h"
+#include "advice-config.h"
 #include "config.h"
 #include "color.h"
 #include "help.h"
@@ -31,48 +33,6 @@ static const char *advise_get_color(enum color_advice ix)
 	return "";
 }
 
-static struct {
-	const char *key;
-	int enabled;
-} advice_setting[] = {
-	[ADVICE_ADD_EMBEDDED_REPO]			= { "addEmbeddedRepo", 1 },
-	[ADVICE_ADD_EMPTY_PATHSPEC]			= { "addEmptyPathspec", 1 },
-	[ADVICE_ADD_IGNORED_FILE]			= { "addIgnoredFile", 1 },
-	[ADVICE_AM_WORK_DIR] 				= { "amWorkDir", 1 },
-	[ADVICE_AMBIGUOUS_FETCH_REFSPEC]		= { "ambiguousFetchRefspec", 1 },
-	[ADVICE_BRANCH_SET_UPSTREAM_FAILURE]		= { "branchSetUpstreamFailure", 1 },
-	[ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME] 	= { "checkoutAmbiguousRemoteBranchName", 1 },
-	[ADVICE_COMMIT_BEFORE_MERGE]			= { "commitBeforeMerge", 1 },
-	[ADVICE_DETACHED_HEAD]				= { "detachedHead", 1 },
-	[ADVICE_SUGGEST_DETACHING_HEAD]			= { "suggestDetachingHead", 1 },
-	[ADVICE_FETCH_SHOW_FORCED_UPDATES]		= { "fetchShowForcedUpdates", 1 },
-	[ADVICE_GRAFT_FILE_DEPRECATED]			= { "graftFileDeprecated", 1 },
-	[ADVICE_IGNORED_HOOK]				= { "ignoredHook", 1 },
-	[ADVICE_IMPLICIT_IDENTITY]			= { "implicitIdentity", 1 },
-	[ADVICE_NESTED_TAG]				= { "nestedTag", 1 },
-	[ADVICE_OBJECT_NAME_WARNING]			= { "objectNameWarning", 1 },
-	[ADVICE_PUSH_ALREADY_EXISTS]			= { "pushAlreadyExists", 1 },
-	[ADVICE_PUSH_FETCH_FIRST]			= { "pushFetchFirst", 1 },
-	[ADVICE_PUSH_NEEDS_FORCE]			= { "pushNeedsForce", 1 },
-	[ADVICE_PUSH_REF_NEEDS_UPDATE]			= { "pushRefNeedsUpdate", 1 },
-	[ADVICE_PUSH_NON_FF_CURRENT]			= { "pushNonFFCurrent", 1 },
-	[ADVICE_PUSH_NON_FF_MATCHING]			= { "pushNonFFMatching", 1 },
-	[ADVICE_PUSH_UNQUALIFIED_REFNAME]		= { "pushUnqualifiedRefName", 1 },
-	[ADVICE_PUSH_UPDATE_REJECTED]			= { "pushUpdateRejected", 1 },
-	[ADVICE_RESET_NO_REFRESH]			= { "resetNoRefresh", 1 },
-	[ADVICE_RESOLVE_CONFLICT]			= { "resolveConflict", 1 },
-	[ADVICE_RM_HINTS]				= { "rmHints", 1 },
-	[ADVICE_SEQUENCER_IN_USE]			= { "sequencerInUse", 1 },
-	[ADVICE_SKIPPED_CHERRY_PICKS]			= { "skippedCherryPicks", 1 },
-	[ADVICE_STATUS_AHEAD_BEHIND]			= { "statusAheadBehind", 1 },
-	[ADVICE_STATUS_HINTS]				= { "statusHints", 1 },
-	[ADVICE_STATUS_UOPTION]				= { "statusUoption", 1 },
-	[ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE] = { "submoduleAlternateErrorStrategyDie", 1 },
-	[ADVICE_SUBMODULES_NOT_UPDATED] 		= { "submodulesNotUpdated", 1 },
-	[ADVICE_UPDATE_SPARSE_PATH]			= { "updateSparsePath", 1 },
-	[ADVICE_WAITING_FOR_EDITOR]			= { "waitingForEditor", 1 },
-};
-
 static const char turn_off_instructions[] =
 N_("\n"
    "Disable this message with \"git config advice.%s false\"");

contrib/buildsystems/CMakeLists.txt

@@ -678,6 +678,13 @@ if(NOT EXISTS ${CMAKE_BINARY_DIR}/advice-type.h)
 			OUTPUT_FILE ${CMAKE_BINARY_DIR}/advice-type.h)
 endif()
 
+if(NOT EXISTS ${CMAKE_BINARY_DIR}/advice-config.h)
+	message("Generating advice-config.h")
+	execute_process(COMMAND ${SH_EXE} ${CMAKE_SOURCE_DIR}/generate-advice.sh advice-config.h
+			WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+			OUTPUT_FILE ${CMAKE_BINARY_DIR}/advice-config.h)
+endif()
+
 include_directories(${CMAKE_BINARY_DIR})
 
 #build

generate-advice.sh

@@ -25,6 +25,15 @@ advice_labels () {
 	txt2label
 }
 
+advice_labels_to_config () {
+	advice_list |
+	while read line
+	do
+		label=$(echo "$line" | txt2label)
+		printf "[%s] = { \"%s\", 1 }\n" "$label" "$line"
+	done
+}
+
 listify () {
 	sed \
 		-e "2,\$s/^/$HT/" \
@@ -35,6 +44,7 @@ case "$#" in
 1) ;;
 *)
 	echo "usage: $0 advice-type.h >advice-type.h"
+	echo "   or: $0 advice-config.h >advice-config.h"
 	exit 1
 esac
 
@@ -47,6 +57,19 @@ enum advice_type {
 	/* Auto-generated from Documentation/config/advice.txt */
 	$(advice_labels | listify)
 };
+EOF
+	;;
+advice-config.h)
+	cat <<EOF
+/* Automatically generated by generate-advice.sh */
+struct advice_entry {
+	const char *key;
+	int enabled;
+};
+
+static struct advice_entry advice_setting[] = {
+	$(advice_labels_to_config | listify)
+};
 EOF
 	;;
 *)