Subject: [PATCH v3 0/1] [Outreachy] config: move documentation to config.h

From: "Heba Waly via GitGitGadget" <[email-masked]>
Date: Wed, 23 Oct 2019 05:30:51 +0000

Move the documentation from Documentation/technical/api-config.txt into
config.h as it's easier for the developers to find the usage information
beside the code instead of looking for it in another doc file, also
documentation/technical/api-config.txt is removed because the information it
has is now redundant and it'll be hard to keep it up to date and
synchronized with the documentation in config.h

Signed-off-by: Heba Waly [email-masked] [[email-masked]]

Heba Waly (1):
  config: move documentation to config.h

 Documentation/technical/api-config.txt | 319 -----------------------
 config.h                               | 335 +++++++++++++++++++++++++
 2 files changed, 335 insertions(+), 319 deletions(-)
 delete mode 100644 Documentation/technical/api-config.txt

base-commit: 108b97dc372828f0e72e56bbb40cae8e1e83ece6
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-405%2FHebaWaly%2Fconfig_documentation-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-405/HebaWaly/config_documentation-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/405

Range-diff vs v2:

 1:  1a9aa33b46 ! 1:  d6cbb3197a config: move documentation to config.h
     @@ -3,7 +3,12 @@
          config: move documentation to config.h
      
          Move the documentation from Documentation/technical/api-config.txt into
     -    config.h
     +    config.h as it's easier for the developers to find the usage information
     +    beside the code instead of looking for it in another doc file, also
     +    documentation/technical/api-config.txt is removed because the information
     +    it has is now redundant and it'll be hard to keep it up to date and
     +    syncronized with the documentation in config.h
     +
          Signed-off-by: Heba Waly <[email-masked]>
      
       diff --git a/Documentation/technical/api-config.txt b/Documentation/technical/api-config.txt
     @@ -341,8 +346,7 @@
      +
      +/**
      + * The config API gives callers a way to access Git configuration files
     -+ * (and files which have the same syntax). See linkgit:git-config[1] for a
     -+ * discussion of the config file syntax.
     ++ * (and files which have the same syntax).
      + *
      + * General Usage
      + * -------------

-- 
gitgitgadget