From: "Heba Waly via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Heba Waly <heba.waly@gmail.com>, Junio C Hamano <gitster@pobox.com>
Subject: [PATCH v3 0/1] [Outreachy] config: move documentation to config.h
Date: Wed, 23 Oct 2019 05:30:51 +0000 [thread overview]
Message-ID: <pull.405.v3.git.1571808652.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.405.v2.git.1571727906.gitgitgadget@gmail.com>
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 heba.waly@gmail.com [heba.waly@gmail.com]
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 <heba.waly@gmail.com>
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
next prev parent reply other threads:[~2019-10-23 5:30 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-18 0:06 [PATCH 0/1] config: add documentation to config.h Heba Waly via GitGitGadget
2019-10-18 0:06 ` [PATCH 1/1] " Heba Waly via GitGitGadget
2019-10-18 22:07 ` Jonathan Tan
2019-10-20 8:05 ` Heba Waly
2019-10-18 22:51 ` Emily Shaffer
2019-10-20 8:35 ` Heba Waly
2019-10-22 20:42 ` Emily Shaffer
2019-10-22 7:05 ` [PATCH v2 0/1] [Outreachy] config: move " Heba Waly via GitGitGadget
2019-10-22 7:05 ` [PATCH v2 1/1] " Heba Waly via GitGitGadget
2019-10-22 20:59 ` Emily Shaffer
2019-10-23 2:14 ` Junio C Hamano
2019-10-23 4:55 ` Heba Waly
2019-10-23 5:30 ` Heba Waly via GitGitGadget [this message]
2019-10-23 5:30 ` [PATCH v3 " Heba Waly via GitGitGadget
2019-10-23 21:38 ` Emily Shaffer
2019-10-24 2:14 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=pull.405.v3.git.1571808652.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=heba.waly@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).