[PATCH] doc: fix repo_config documentation reference

[PATCH] doc: fix repo_config documentation reference

[Soutrik Das via GitGitGadget]

From: SoutrikDas <valusoutrik@gmail.com>

Since documentation was moved from Documenation/
technical/api-config to inside the config.h
This might help newcomers, by pointing them to the
right place to get documentation about repo_config

Signed-off-by: SoutrikDas <valusoutrik@gmail.com>
---
    doc: fix repo_config documentation reference

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2187%2FSoutrikDas%2Fdoc-fix-myfirstcontribution-config-ref-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2187/SoutrikDas/doc-fix-myfirstcontribution-config-ref-v1
Pull-Request: https://github.com/git/git/pull/2187

 Documentation/MyFirstContribution.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index f186dfbc89..92de476a7f 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -351,7 +351,7 @@ function body:
 apply standard precedence rules. `repo_config_get_string_tmp()` will look up
 a specific key ("user.name") and give you the value. There are a number of
 single-key lookup functions like this one; you can see them all (and more info
-about how to use `repo_config()`) in `Documentation/technical/api-config.adoc`.
+about how to use `repo_config()`) in `config.h`.
 
 You should see that the name printed matches the one you see when you run:
 

base-commit: b2826b52eb7caff9f4ed6e85ec45e338bf02ad09
-- 
gitgitgadget

Re: [PATCH] doc: fix repo_config documentation reference

[Shreyansh Paliwal]

> Since documentation was moved from Documenation/
> technical/api-config to inside the config.h
> This might help newcomers, by pointing them to the
> right place to get documentation about repo_config

Some suggestions,

* s/Documenation/Documentation

* ~70 cols is the practical followed line wrapping, so you can follow that
for best readability.

* First describe the current problem statement which describes the
current state in the present tense like,

   In MyFirstContribution.adoc, the link to the repo_config()
   documentation is invalid because the documentation related was moved
   to a different file.

* Then you instruct somebody to make changes to the code to make it better like,

   Replace the path for the repo_config() documentation from
   'Documenation/technical/api-config' to 'config.h'.

* Then you can state your additional explainations, references and/or
advantages, whatever seems relevant for the change you just stated.

Best,
Shreyansh

Re: [PATCH] doc: fix repo_config documentation reference

[SoutrikDas]

- Documenation spelling corrected

> First describe the current problem statement which describes the 
> current state in the present tense like 
> "In MyFirstContribution.adoc, the link to the repo_config() 
> documentation is invalid because the documentation related was 
> moved to a different file."

Let this be A 

> Then you instruct somebody to make changes to the code to make it 
> better like 
> Replace the path for the repo_config() documentation from 
> 'Documentation/technical/api-config' to 'config.h'.

Let this be B

So the Commit will be 
> <short tile> 
> 
> <B> 

And the cover mail for that patch will be 
> <short tile same as commit message ? > 
> 
> <A>
>
> <B> 

I configured my git send-email because I couldnt reply to your email
with gitgitgadget ... maybe it was my mistake. Anyway I wanted to ask
Now that I have changed the commit message , what should I do ? 
Should I send a [PATCH v2] as a seperate thread or send it here ?

[GSOC PATCH v2] doc: fix repo_config documentation reference

[SoutrikDas]

In MyFirstContribution.adoc, the link to the repo_config() 
documentation is invalid because the related documentation was moved 
to a different file.

Replace the path for the repo_config() documentation from
'Documentation/technical/api-config.h' to 'config.h'.

Signed-off-by: SoutrikDas <valusoutrik@gmail.com>
---
Changes from v1 : 
Corrected Documentation Spelling
Added .h after api-config
Changed Commit message to suit git's style
---
 Documentation/MyFirstContribution.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index f186dfbc89..92de476a7f 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -351,7 +351,7 @@ function body:
 apply standard precedence rules. `repo_config_get_string_tmp()` will look up
 a specific key ("user.name") and give you the value. There are a number of
 single-key lookup functions like this one; you can see them all (and more info
-about how to use `repo_config()`) in `Documentation/technical/api-config.adoc`.
+about how to use `repo_config()`) in `config.h`.
 
 You should see that the name printed matches the one you see when you run:
 
-- 
2.50.1 (Apple Git-155)

Re: [GSOC PATCH v2] doc: fix repo_config documentation reference

[Junio C Hamano]

SoutrikDas <valusoutrik@gmail.com> writes:

> In MyFirstContribution.adoc, the link to the repo_config() 
> documentation is invalid because the related documentation was moved 
> to a different file.
>
> Replace the path for the repo_config() documentation from
> 'Documentation/technical/api-config.h' to 'config.h'.

OK.  I eyeballed output from

    $ git grep 'Documentation/technical/.*\.adoc' Documentation/

and everything else mentioned are still there.

Thanks.

>
> Signed-off-by: SoutrikDas <valusoutrik@gmail.com>
> ---
> Changes from v1 : 
> Corrected Documentation Spelling
> Added .h after api-config
> Changed Commit message to suit git's style
> ---
>  Documentation/MyFirstContribution.adoc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
> index f186dfbc89..92de476a7f 100644
> --- a/Documentation/MyFirstContribution.adoc
> +++ b/Documentation/MyFirstContribution.adoc
> @@ -351,7 +351,7 @@ function body:
>  apply standard precedence rules. `repo_config_get_string_tmp()` will look up
>  a specific key ("user.name") and give you the value. There are a number of
>  single-key lookup functions like this one; you can see them all (and more info
> -about how to use `repo_config()`) in `Documentation/technical/api-config.adoc`.
> +about how to use `repo_config()`) in `config.h`.
>  
>  You should see that the name printed matches the one you see when you run: