git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
* [PATCH] README.md: add CodingGuidelines and a link for Translators
@ 2022-01-14 17:50 Philip Oakley via GitGitGadget
  2022-01-14 20:54 ` Junio C Hamano
  2022-01-16 16:11 ` [PATCH v2] " Philip Oakley via GitGitGadget
  0 siblings, 2 replies; 11+ messages in thread
From: Philip Oakley via GitGitGadget @ 2022-01-14 17:50 UTC (permalink / raw)
  To: git; +Cc: Philip Oakley, Philip Oakley

From: Philip Oakley <philipoakley@iee.email>

Also space out the list joining instructions and clarify the subscription
via the majordomo address.

Signed-off-by: Philip Oakley <philipoakley@iee.email>
---
    README.md: add CodingGuidelines and a link for Translators
    
    Also space out the list joining instructions and clarify the
    subscription via the majordomo address.
    
    Signed-off-by: Philip Oakley philipoakley@iee.email

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1115%2FPhilipOakley%2FReadme-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1115/PhilipOakley/Readme-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1115

 README.md | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index f6f43e78deb..5c956dea6e0 100644
--- a/README.md
+++ b/README.md
@@ -32,10 +32,16 @@ installed).
 The user discussion and development of Git take place on the Git
 mailing list -- everyone is welcome to post bug reports, feature
 requests, comments and patches to git@vger.kernel.org (read
-[Documentation/SubmittingPatches][] for instructions on patch submission).
+[Documentation/SubmittingPatches][] for instructions on patch submission
+and [Documentation/CodingGuidelines]() ).
+
+Those wishing to help with error message translation (localization L10)
+should see [po/README.md]()
+(a `po` file is a portable object file for the translations).
+
 To subscribe to the list, send an email with just "subscribe git" in
-the body to majordomo@vger.kernel.org. The mailing list archives are
-available at <https://lore.kernel.org/git/>,
+the body to majordomo@vger.kernel.org (not the list). The mailing list
+archives are available at <https://lore.kernel.org/git/>,
 <http://marc.info/?l=git> and other archival sites.
 
 Issues which are security relevant should be disclosed privately to

base-commit: 1ffcbaa1a5f10c9f706314d77f88de20a4a498c2
-- 
gitgitgadget

^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [PATCH] README.md: add CodingGuidelines and a link for Translators
  2022-01-14 17:50 [PATCH] README.md: add CodingGuidelines and a link for Translators Philip Oakley via GitGitGadget
@ 2022-01-14 20:54 ` Junio C Hamano
  2022-01-15  0:08   ` Philip Oakley
  2022-01-16 16:11 ` [PATCH v2] " Philip Oakley via GitGitGadget
  1 sibling, 1 reply; 11+ messages in thread
From: Junio C Hamano @ 2022-01-14 20:54 UTC (permalink / raw)
  To: Philip Oakley via GitGitGadget; +Cc: git, Philip Oakley

"Philip Oakley via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Philip Oakley <philipoakley@iee.email>
>
> Also space out the list joining instructions and clarify the subscription

the instructions to join the list?

>  requests, comments and patches to git@vger.kernel.org (read
> -[Documentation/SubmittingPatches][] for instructions on patch submission).
> +[Documentation/SubmittingPatches][] for instructions on patch submission
> +and [Documentation/CodingGuidelines]() ).

Remind me the significance of using [] and () after [File Reference]?

> +Those wishing to help with error message translation (localization L10)
> +should see [po/README.md]()

Same here.

https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links

seems to indicate () is to enclose URL the text goes to, and if
there is no URL to go to, perhaps it does the right thing, but the
current page (which has "[Documentation/SubmittingPatches][]" and
all other reference into in-tree files with that format) seems to
render correctly with links that work, so...

> +(a `po` file is a portable object file for the translations).
> +
>  To subscribe to the list, send an email with just "subscribe git" in
> -the body to majordomo@vger.kernel.org. The mailing list archives are
> -available at <https://lore.kernel.org/git/>,
> +the body to majordomo@vger.kernel.org (not the list). The mailing list
> +archives are available at <https://lore.kernel.org/git/>,
>  <http://marc.info/?l=git> and other archival sites.
>  
>  Issues which are security relevant should be disclosed privately to
>
> base-commit: 1ffcbaa1a5f10c9f706314d77f88de20a4a498c2

^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [PATCH] README.md: add CodingGuidelines and a link for Translators
  2022-01-14 20:54 ` Junio C Hamano
@ 2022-01-15  0:08   ` Philip Oakley
  2022-01-15  0:47     ` Junio C Hamano
  0 siblings, 1 reply; 11+ messages in thread
From: Philip Oakley @ 2022-01-15  0:08 UTC (permalink / raw)
  To: Junio C Hamano, Philip Oakley via GitGitGadget; +Cc: git

On 14/01/2022 20:54, Junio C Hamano wrote:
> "Philip Oakley via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
>> From: Philip Oakley <philipoakley@iee.email>
>>
>> Also space out the list joining instructions and clarify the subscription
> the instructions to join the list?
Correct.
>
>>  requests, comments and patches to git@vger.kernel.org (read
>> -[Documentation/SubmittingPatches][] for instructions on patch submission).
>> +[Documentation/SubmittingPatches][] for instructions on patch submission
>> +and [Documentation/CodingGuidelines]() ).
> Remind me the significance of using [] and () after [File Reference]?
The [] is the original method used by the unchanged text, while the ()
appears to be the method required now.
 
>
>> +Those wishing to help with error message translation (localization L10)
>> +should see [po/README.md]()
> Same here.
>
> https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links
>
> seems to indicate () is to enclose URL the text goes to, and if
> there is no URL to go to, perhaps it does the right thing, but the
> current page (which has "[Documentation/SubmittingPatches][]" and
> all other reference into in-tree files with that format) seems to
> render correctly with links that work, so...

Unfortunately it `[]` is not working for me for the new additions.
GitHub magic?
>
>> +(a `po` file is a portable object file for the translations).
>> +
>>  To subscribe to the list, send an email with just "subscribe git" in
>> -the body to majordomo@vger.kernel.org. The mailing list archives are
>> -available at <https://lore.kernel.org/git/>,
>> +the body to majordomo@vger.kernel.org (not the list). The mailing list
>> +archives are available at <https://lore.kernel.org/git/>,
>>  <http://marc.info/?l=git> and other archival sites.
>>  
>>  Issues which are security relevant should be disclosed privately to
>>
>> base-commit: 1ffcbaa1a5f10c9f706314d77f88de20a4a498c2


^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [PATCH] README.md: add CodingGuidelines and a link for Translators
  2022-01-15  0:08   ` Philip Oakley
@ 2022-01-15  0:47     ` Junio C Hamano
  0 siblings, 0 replies; 11+ messages in thread
From: Junio C Hamano @ 2022-01-15  0:47 UTC (permalink / raw)
  To: Philip Oakley; +Cc: Philip Oakley via GitGitGadget, git

Philip Oakley <philipoakley@iee.email> writes:

> Unfortunately it `[]` is not working for me for the new additions.
> GitHub magic?

Let's step back a bit.

Is there somebody reading README.md as a more generic MarkDown?  I
do not think our build procedure creates any rendered document from
it.

My recollection was that we moved from README.txt to README.md for
the sole purpose of showing it https://github.com/git/git/ as more
than just a plain text, so it is a hard requirement that GitHub
flavored MarkDown renderer is happy with whatever we write in the
file.

If GitHub flavored MarkDown only supports [] and breaks with (),
then there is no need for further discussion.  We must stick to []
that has been working for us in the file.

On the other hand, if both () and [] work well at GitHub, I am OK to
replace [] to (), so that it shows well at GitHub and also it can be
used with other MarkDown renderers.

I prefer, from the organizational point of view, to see two patches,
in this order, if we were to go that way.

 [PATCH 1/2] README: link to more contributor documents

which uses [] (not ()).  After this, README.md uses only [],
including the two links you add in this step.  And then

 [PATCH 2/2] README: use "()", not "[]", to please more MarkDown processors

which replaces all uses of [] with ().

That would allow us to queue both, try them out, and we can back out
[2/2] if GitHub's renderer does not like the result.


^ permalink raw reply	[flat|nested] 11+ messages in thread

* [PATCH v2] README.md: add CodingGuidelines and a link for Translators
  2022-01-14 17:50 [PATCH] README.md: add CodingGuidelines and a link for Translators Philip Oakley via GitGitGadget
  2022-01-14 20:54 ` Junio C Hamano
@ 2022-01-16 16:11 ` Philip Oakley via GitGitGadget
  2022-01-16 22:47   ` Junio C Hamano
                     ` (2 more replies)
  1 sibling, 3 replies; 11+ messages in thread
From: Philip Oakley via GitGitGadget @ 2022-01-16 16:11 UTC (permalink / raw)
  To: git; +Cc: Philip Oakley, Philip Oakley

From: Philip Oakley <philipoakley@iee.email>

The README.md does not use the GitHub Markdown URL links [1] of
[txt](url), rather the reference method [2] of trailing empty square
brackets. The references themselves are listed at the foot of the
document. Those footers are not shown by GitHub/GitLab rendering.

Also space out the list joining instructions and clarify that
subscription is via the majordomo address.

[1] https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links
[2] https://gist.github.com/ChrisTollefson/a3af6d902a74a0afd1c2d79aadc9bb3f#reference-links

Signed-off-by: Philip Oakley <philipoakley@iee.email>
---
    README.md: add CodingGuidelines and a link for Translators
    
    Also space out the list joining instructions and clarify the
    subscription via the majordomo address.
    
    
    Signed-off-by: Philip Oakley philipoakley@iee.email
    ===================================================
    
    cc: Philip Oakley philipoakley@iee.email cc: Junio C Hamano
    gitster@pobox.com cc: Jiang Xin worldhello.net@gmail.com
    
    changes since v1:
    
     * Used reference style links, rather than lnk [url] style.
    
     * added Jianf as L10 coordinator.
    
     * note: Patch is a response to a user question on the "Git for Human
       Beings" git-users list
       https://groups.google.com/d/msgid/git-users/aa68b9c8-4cf4-4193-8af3-79d7e3feafbbn%40googlegroups.com

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1115%2FPhilipOakley%2FReadme-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1115/PhilipOakley/Readme-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/1115

Range-diff vs v1:

 1:  ac6d0abbdde ! 1:  48cc30b7cc8 README.md: add CodingGuidelines and a link for Translators
     @@ Metadata
       ## Commit message ##
          README.md: add CodingGuidelines and a link for Translators
      
     -    Also space out the list joining instructions and clarify the subscription
     -    via the majordomo address.
     +    The README.md does not use the GitHub Markdown URL links [1] of
     +    [txt](url), rather the reference method [2] of trailing empty square
     +    brackets. The references themselves are listed at the foot of the
     +    document. Those footers are not shown by GitHub/GitLab rendering.
     +
     +    Also space out the list joining instructions and clarify that
     +    subscription is via the majordomo address.
     +
     +    [1] https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links
     +    [2] https://gist.github.com/ChrisTollefson/a3af6d902a74a0afd1c2d79aadc9bb3f#reference-links
      
          Signed-off-by: Philip Oakley <philipoakley@iee.email>
      
     @@ README.md: installed).
       requests, comments and patches to git@vger.kernel.org (read
      -[Documentation/SubmittingPatches][] for instructions on patch submission).
      +[Documentation/SubmittingPatches][] for instructions on patch submission
     -+and [Documentation/CodingGuidelines]() ).
     ++and [Documentation/CodingGuidelines][]).
      +
      +Those wishing to help with error message translation (localization L10)
     -+should see [po/README.md]()
     -+(a `po` file is a portable object file for the translations).
     ++should see [po/README.md][] (a `po` file is a Portable Object file that
     ++holds the translations).
      +
       To subscribe to the list, send an email with just "subscribe git" in
      -the body to majordomo@vger.kernel.org. The mailing list archives are
      -available at <https://lore.kernel.org/git/>,
     -+the body to majordomo@vger.kernel.org (not the list). The mailing list
     -+archives are available at <https://lore.kernel.org/git/>,
     ++the body to majordomo@vger.kernel.org (not the Git list). The mailing
     ++list archives are available at <https://lore.kernel.org/git/>,
       <http://marc.info/?l=git> and other archival sites.
       
       Issues which are security relevant should be disclosed privately to
     +@@ README.md: and the name as (depending on your mood):
     + [Documentation/giteveryday.txt]: Documentation/giteveryday.txt
     + [Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
     + [Documentation/SubmittingPatches]: Documentation/SubmittingPatches
     ++[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
     ++[po/README.md]: po/README.md
     + \ No newline at end of file


 README.md | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index f6f43e78deb..d2b061e3998 100644
--- a/README.md
+++ b/README.md
@@ -32,10 +32,16 @@ installed).
 The user discussion and development of Git take place on the Git
 mailing list -- everyone is welcome to post bug reports, feature
 requests, comments and patches to git@vger.kernel.org (read
-[Documentation/SubmittingPatches][] for instructions on patch submission).
+[Documentation/SubmittingPatches][] for instructions on patch submission
+and [Documentation/CodingGuidelines][]).
+
+Those wishing to help with error message translation (localization L10)
+should see [po/README.md][] (a `po` file is a Portable Object file that
+holds the translations).
+
 To subscribe to the list, send an email with just "subscribe git" in
-the body to majordomo@vger.kernel.org. The mailing list archives are
-available at <https://lore.kernel.org/git/>,
+the body to majordomo@vger.kernel.org (not the Git list). The mailing
+list archives are available at <https://lore.kernel.org/git/>,
 <http://marc.info/?l=git> and other archival sites.
 
 Issues which are security relevant should be disclosed privately to
@@ -64,3 +70,5 @@ and the name as (depending on your mood):
 [Documentation/giteveryday.txt]: Documentation/giteveryday.txt
 [Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
 [Documentation/SubmittingPatches]: Documentation/SubmittingPatches
+[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
+[po/README.md]: po/README.md
\ No newline at end of file

base-commit: 1ffcbaa1a5f10c9f706314d77f88de20a4a498c2
-- 
gitgitgadget

^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [PATCH v2] README.md: add CodingGuidelines and a link for Translators
  2022-01-16 16:11 ` [PATCH v2] " Philip Oakley via GitGitGadget
@ 2022-01-16 22:47   ` Junio C Hamano
  2022-01-17 18:08     ` Philip Oakley
  2022-01-17  9:00   ` Bagas Sanjaya
  2022-01-17 18:18   ` [PATCH v3] " Philip Oakley via GitGitGadget
  2 siblings, 1 reply; 11+ messages in thread
From: Junio C Hamano @ 2022-01-16 22:47 UTC (permalink / raw)
  To: Philip Oakley via GitGitGadget; +Cc: git, Philip Oakley

"Philip Oakley via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Philip Oakley <philipoakley@iee.email>
>
> The README.md does not use the GitHub Markdown URL links [1] of
> [txt](url), rather the reference method [2] of trailing empty square
> brackets. The references themselves are listed at the foot of the
> document. Those footers are not shown by GitHub/GitLab rendering.

Thanks for tracking down the differences.

The above only describes what we could do (i.e. use links instead of
reference), and how the current document is rendered (i.e. footers
are not shown).  No changes come from the above description.

> Also space out the list joining instructions and clarify that
> subscription is via the majordomo address.

So, seeing "Also" immediately after a paragraph that explains the
status quo confused me a lot.

"Spell out the instructions to join the list, and clarify that the
subscription is via the majordomo address" is indeed a part of what
this patch does.  Perhaps we need a separate paragraph _before_ this
"Also".

So taking all together

    Before being told how to submit patches, new contributors need
    to be told how to code for, or how to contribute translation to,
    the project.  Add references to the CodingGuidelines and the
    README document on localization.

    Also, spell out the instructions to join the list and ...
    
    We use GitHub Markdown reference [2] with trailing empty square
    brackets, to match existing text in the file.  On GitHub/GitLab
    pages, these references are not shown on the page, but it is OK
    because they are empty.  We could switch to using [text](url)
    form [1] if we wanted to, but that is not done as part of this
    patch.

would be the presentation order that I would expect to be the most
readable.  I moved the discussion between URL link and reference, as
it is merely a hint for future and not the core thing that needs to
be explained to understand the changes in this commit.

Thanks.


> [1] https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links
> [2] https://gist.github.com/ChrisTollefson/a3af6d902a74a0afd1c2d79aadc9bb3f#reference-links
>
> Signed-off-by: Philip Oakley <philipoakley@iee.email>
> ---
>     README.md: add CodingGuidelines and a link for Translators
>     
>     Also space out the list joining instructions and clarify the
>     subscription via the majordomo address.
>     
>     
>     Signed-off-by: Philip Oakley philipoakley@iee.email
>     ===================================================
>     
>     cc: Philip Oakley philipoakley@iee.email cc: Junio C Hamano
>     gitster@pobox.com cc: Jiang Xin worldhello.net@gmail.com
>     
>     changes since v1:
>     
>      * Used reference style links, rather than lnk [url] style.
>     
>      * added Jianf as L10 coordinator.
>     
>      * note: Patch is a response to a user question on the "Git for Human
>        Beings" git-users list
>        https://groups.google.com/d/msgid/git-users/aa68b9c8-4cf4-4193-8af3-79d7e3feafbbn%40googlegroups.com
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1115%2FPhilipOakley%2FReadme-v2
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1115/PhilipOakley/Readme-v2
> Pull-Request: https://github.com/gitgitgadget/git/pull/1115
>
> Range-diff vs v1:
>
>  1:  ac6d0abbdde ! 1:  48cc30b7cc8 README.md: add CodingGuidelines and a link for Translators
>      @@ Metadata
>        ## Commit message ##
>           README.md: add CodingGuidelines and a link for Translators
>       
>      -    Also space out the list joining instructions and clarify the subscription
>      -    via the majordomo address.
>      +    The README.md does not use the GitHub Markdown URL links [1] of
>      +    [txt](url), rather the reference method [2] of trailing empty square
>      +    brackets. The references themselves are listed at the foot of the
>      +    document. Those footers are not shown by GitHub/GitLab rendering.
>      +
>      +    Also space out the list joining instructions and clarify that
>      +    subscription is via the majordomo address.
>      +
>      +    [1] https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links
>      +    [2] https://gist.github.com/ChrisTollefson/a3af6d902a74a0afd1c2d79aadc9bb3f#reference-links
>       
>           Signed-off-by: Philip Oakley <philipoakley@iee.email>
>       
>      @@ README.md: installed).
>        requests, comments and patches to git@vger.kernel.org (read
>       -[Documentation/SubmittingPatches][] for instructions on patch submission).
>       +[Documentation/SubmittingPatches][] for instructions on patch submission
>      -+and [Documentation/CodingGuidelines]() ).
>      ++and [Documentation/CodingGuidelines][]).
>       +
>       +Those wishing to help with error message translation (localization L10)
>      -+should see [po/README.md]()
>      -+(a `po` file is a portable object file for the translations).
>      ++should see [po/README.md][] (a `po` file is a Portable Object file that
>      ++holds the translations).
>       +
>        To subscribe to the list, send an email with just "subscribe git" in
>       -the body to majordomo@vger.kernel.org. The mailing list archives are
>       -available at <https://lore.kernel.org/git/>,
>      -+the body to majordomo@vger.kernel.org (not the list). The mailing list
>      -+archives are available at <https://lore.kernel.org/git/>,
>      ++the body to majordomo@vger.kernel.org (not the Git list). The mailing
>      ++list archives are available at <https://lore.kernel.org/git/>,
>        <http://marc.info/?l=git> and other archival sites.
>        
>        Issues which are security relevant should be disclosed privately to
>      +@@ README.md: and the name as (depending on your mood):
>      + [Documentation/giteveryday.txt]: Documentation/giteveryday.txt
>      + [Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
>      + [Documentation/SubmittingPatches]: Documentation/SubmittingPatches
>      ++[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
>      ++[po/README.md]: po/README.md
>      + \ No newline at end of file
>
>
>  README.md | 14 +++++++++++---
>  1 file changed, 11 insertions(+), 3 deletions(-)
>
> diff --git a/README.md b/README.md
> index f6f43e78deb..d2b061e3998 100644
> --- a/README.md
> +++ b/README.md
> @@ -32,10 +32,16 @@ installed).
>  The user discussion and development of Git take place on the Git
>  mailing list -- everyone is welcome to post bug reports, feature
>  requests, comments and patches to git@vger.kernel.org (read
> -[Documentation/SubmittingPatches][] for instructions on patch submission).
> +[Documentation/SubmittingPatches][] for instructions on patch submission
> +and [Documentation/CodingGuidelines][]).
> +
> +Those wishing to help with error message translation (localization L10)
> +should see [po/README.md][] (a `po` file is a Portable Object file that
> +holds the translations).
> +
>  To subscribe to the list, send an email with just "subscribe git" in
> -the body to majordomo@vger.kernel.org. The mailing list archives are
> -available at <https://lore.kernel.org/git/>,
> +the body to majordomo@vger.kernel.org (not the Git list). The mailing
> +list archives are available at <https://lore.kernel.org/git/>,
>  <http://marc.info/?l=git> and other archival sites.
>  
>  Issues which are security relevant should be disclosed privately to
> @@ -64,3 +70,5 @@ and the name as (depending on your mood):
>  [Documentation/giteveryday.txt]: Documentation/giteveryday.txt
>  [Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
>  [Documentation/SubmittingPatches]: Documentation/SubmittingPatches
> +[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
> +[po/README.md]: po/README.md
> \ No newline at end of file
>
> base-commit: 1ffcbaa1a5f10c9f706314d77f88de20a4a498c2

^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [PATCH v2] README.md: add CodingGuidelines and a link for Translators
  2022-01-16 16:11 ` [PATCH v2] " Philip Oakley via GitGitGadget
  2022-01-16 22:47   ` Junio C Hamano
@ 2022-01-17  9:00   ` Bagas Sanjaya
  2022-01-17 17:52     ` Philip Oakley
  2022-01-17 18:49     ` Junio C Hamano
  2022-01-17 18:18   ` [PATCH v3] " Philip Oakley via GitGitGadget
  2 siblings, 2 replies; 11+ messages in thread
From: Bagas Sanjaya @ 2022-01-17  9:00 UTC (permalink / raw)
  To: Philip Oakley via GitGitGadget, git; +Cc: Philip Oakley

On 16/01/22 23.11, Philip Oakley via GitGitGadget wrote:
> +Those wishing to help with error message translation (localization L10)
> +should see [po/README.md][] (a `po` file is a Portable Object file that
> +holds the translations).
> +

I mean not just error messages are in po/*.po, but also usage and informational
strings. We can say "Those wishing to help translating message strings
(localization or l10n)...".

-- 
An old man doll... just what I always wanted! - Clara

^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [PATCH v2] README.md: add CodingGuidelines and a link for Translators
  2022-01-17  9:00   ` Bagas Sanjaya
@ 2022-01-17 17:52     ` Philip Oakley
  2022-01-17 18:49     ` Junio C Hamano
  1 sibling, 0 replies; 11+ messages in thread
From: Philip Oakley @ 2022-01-17 17:52 UTC (permalink / raw)
  To: Bagas Sanjaya, Philip Oakley via GitGitGadget, git

On 17/01/2022 09:00, Bagas Sanjaya wrote:
> On 16/01/22 23.11, Philip Oakley via GitGitGadget wrote:
>> +Those wishing to help with error message translation (localization L10)
>> +should see [po/README.md][] (a `po` file is a Portable Object file that
>> +holds the translations).
>> +
>
> I mean not just error messages are in po/*.po, but also usage and
> informational
> strings. We can say "Those wishing to help translating message strings
> (localization or l10n)...".
>
Thanks, I've expended the README description.

Philip

^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [PATCH v2] README.md: add CodingGuidelines and a link for Translators
  2022-01-16 22:47   ` Junio C Hamano
@ 2022-01-17 18:08     ` Philip Oakley
  0 siblings, 0 replies; 11+ messages in thread
From: Philip Oakley @ 2022-01-17 18:08 UTC (permalink / raw)
  To: Junio C Hamano, Philip Oakley via GitGitGadget; +Cc: git

On 16/01/2022 22:47, Junio C Hamano wrote:
> "Philip Oakley via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
>> From: Philip Oakley <philipoakley@iee.email>
>>
>> The README.md does not use the GitHub Markdown URL links [1] of
>> [txt](url), rather the reference method [2] of trailing empty square
>> brackets. The references themselves are listed at the foot of the
>> document. Those footers are not shown by GitHub/GitLab rendering.
> Thanks for tracking down the differences.
I found an additional GitHub link for the reference method (not easy to
find), which I have added.
>
> The above only describes what we could do (i.e. use links instead of
> reference), and how the current document is rendered (i.e. footers
> are not shown).  No changes come from the above description.
>
>> Also space out the list joining instructions and clarify that
>> subscription is via the majordomo address.
> So, seeing "Also" immediately after a paragraph that explains the
> status quo confused me a lot.
>
> "Spell out the instructions to join the list, and clarify that the
> subscription is via the majordomo address" is indeed a part of what
> this patch does.  Perhaps we need a separate paragraph _before_ this
> "Also".
>
> So taking all together
>
>     Before being told how to submit patches, new contributors need
>     to be told how to code for, or how to contribute translation to,
>     the project.  Add references to the CodingGuidelines and the
>     README document on localization.
>
>     Also, spell out the instructions to join the list and ...
>     
>     We use GitHub Markdown reference [2] with trailing empty square
>     brackets, to match existing text in the file.  On GitHub/GitLab
>     pages, these references are not shown on the page, but it is OK
>     because they are empty.  We could switch to using [text](url)
>     form [1] if we wanted to, but that is not done as part of this
>     patch.
>
> would be the presentation order that I would expect to be the most
> readable.  I moved the discussion between URL link and reference, as
> it is merely a hint for future and not the core thing that needs to
> be explained to understand the changes in this commit.
I've taken your suggestions and added a small clarification about the
awkward empty square bracket links, which are repeated in the README's
footer, but not shown on the Github rendered web page.. I also took
Bagas' text changes for the readme itself

GGG V3 to follow,...

Thank you
>
> Thanks.
>
>
>> [1] https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links
>> [2] https://gist.github.com/ChrisTollefson/a3af6d902a74a0afd1c2d79aadc9bb3f#reference-links
>>
>> Signed-off-by: Philip Oakley <philipoakley@iee.email>
>> ---
>>     README.md: add CodingGuidelines and a link for Translators
>>     
>>     Also space out the list joining instructions and clarify the
>>     subscription via the majordomo address.
>>     
>>     
>>     Signed-off-by: Philip Oakley philipoakley@iee.email
>>     ===================================================
>>     
>>     cc: Philip Oakley philipoakley@iee.email cc: Junio C Hamano
>>     gitster@pobox.com cc: Jiang Xin worldhello.net@gmail.com
>>     
>>     changes since v1:
>>     
>>      * Used reference style links, rather than lnk [url] style.
>>     
>>      * added Jianf as L10 coordinator.
>>     
>>      * note: Patch is a response to a user question on the "Git for Human
>>        Beings" git-users list
>>        https://groups.google.com/d/msgid/git-users/aa68b9c8-4cf4-4193-8af3-79d7e3feafbbn%40googlegroups.com
>>
>> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1115%2FPhilipOakley%2FReadme-v2
>> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1115/PhilipOakley/Readme-v2
>> Pull-Request: https://github.com/gitgitgadget/git/pull/1115
>>
>> Range-diff vs v1:
>>
>>  1:  ac6d0abbdde ! 1:  48cc30b7cc8 README.md: add CodingGuidelines and a link for Translators
>>      @@ Metadata
>>        ## Commit message ##
>>           README.md: add CodingGuidelines and a link for Translators
>>       
>>      -    Also space out the list joining instructions and clarify the subscription
>>      -    via the majordomo address.
>>      +    The README.md does not use the GitHub Markdown URL links [1] of
>>      +    [txt](url), rather the reference method [2] of trailing empty square
>>      +    brackets. The references themselves are listed at the foot of the
>>      +    document. Those footers are not shown by GitHub/GitLab rendering.
>>      +
>>      +    Also space out the list joining instructions and clarify that
>>      +    subscription is via the majordomo address.
>>      +
>>      +    [1] https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links
>>      +    [2] https://gist.github.com/ChrisTollefson/a3af6d902a74a0afd1c2d79aadc9bb3f#reference-links
>>       
>>           Signed-off-by: Philip Oakley <philipoakley@iee.email>
>>       
>>      @@ README.md: installed).
>>        requests, comments and patches to git@vger.kernel.org (read
>>       -[Documentation/SubmittingPatches][] for instructions on patch submission).
>>       +[Documentation/SubmittingPatches][] for instructions on patch submission
>>      -+and [Documentation/CodingGuidelines]() ).
>>      ++and [Documentation/CodingGuidelines][]).
>>       +
>>       +Those wishing to help with error message translation (localization L10)
>>      -+should see [po/README.md]()
>>      -+(a `po` file is a portable object file for the translations).
>>      ++should see [po/README.md][] (a `po` file is a Portable Object file that
>>      ++holds the translations).
>>       +
>>        To subscribe to the list, send an email with just "subscribe git" in
>>       -the body to majordomo@vger.kernel.org. The mailing list archives are
>>       -available at <https://lore.kernel.org/git/>,
>>      -+the body to majordomo@vger.kernel.org (not the list). The mailing list
>>      -+archives are available at <https://lore.kernel.org/git/>,
>>      ++the body to majordomo@vger.kernel.org (not the Git list). The mailing
>>      ++list archives are available at <https://lore.kernel.org/git/>,
>>        <http://marc.info/?l=git> and other archival sites.
>>        
>>        Issues which are security relevant should be disclosed privately to
>>      +@@ README.md: and the name as (depending on your mood):
>>      + [Documentation/giteveryday.txt]: Documentation/giteveryday.txt
>>      + [Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
>>      + [Documentation/SubmittingPatches]: Documentation/SubmittingPatches
>>      ++[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
>>      ++[po/README.md]: po/README.md
>>      + \ No newline at end of file
>>
>>
>>  README.md | 14 +++++++++++---
>>  1 file changed, 11 insertions(+), 3 deletions(-)
>>
>> diff --git a/README.md b/README.md
>> index f6f43e78deb..d2b061e3998 100644
>> --- a/README.md
>> +++ b/README.md
>> @@ -32,10 +32,16 @@ installed).
>>  The user discussion and development of Git take place on the Git
>>  mailing list -- everyone is welcome to post bug reports, feature
>>  requests, comments and patches to git@vger.kernel.org (read
>> -[Documentation/SubmittingPatches][] for instructions on patch submission).
>> +[Documentation/SubmittingPatches][] for instructions on patch submission
>> +and [Documentation/CodingGuidelines][]).
>> +
>> +Those wishing to help with error message translation (localization L10)
>> +should see [po/README.md][] (a `po` file is a Portable Object file that
>> +holds the translations).
>> +
>>  To subscribe to the list, send an email with just "subscribe git" in
>> -the body to majordomo@vger.kernel.org. The mailing list archives are
>> -available at <https://lore.kernel.org/git/>,
>> +the body to majordomo@vger.kernel.org (not the Git list). The mailing
>> +list archives are available at <https://lore.kernel.org/git/>,
>>  <http://marc.info/?l=git> and other archival sites.
>>  
>>  Issues which are security relevant should be disclosed privately to
>> @@ -64,3 +70,5 @@ and the name as (depending on your mood):
>>  [Documentation/giteveryday.txt]: Documentation/giteveryday.txt
>>  [Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
>>  [Documentation/SubmittingPatches]: Documentation/SubmittingPatches
>> +[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
>> +[po/README.md]: po/README.md
>> \ No newline at end of file
>>
>> base-commit: 1ffcbaa1a5f10c9f706314d77f88de20a4a498c2


^ permalink raw reply	[flat|nested] 11+ messages in thread

* [PATCH v3] README.md: add CodingGuidelines and a link for Translators
  2022-01-16 16:11 ` [PATCH v2] " Philip Oakley via GitGitGadget
  2022-01-16 22:47   ` Junio C Hamano
  2022-01-17  9:00   ` Bagas Sanjaya
@ 2022-01-17 18:18   ` Philip Oakley via GitGitGadget
  2 siblings, 0 replies; 11+ messages in thread
From: Philip Oakley via GitGitGadget @ 2022-01-17 18:18 UTC (permalink / raw)
  To: git; +Cc: Philip Oakley, Philip Oakley

From: Philip Oakley <philipoakley@iee.email>

Before being told how to submit patches, new contributors need
to be told how to code for, or how to contribute translation to,
the project.  Add references to the CodingGuidelines and the
README document on localization.

Also, split out the instructions to join the list and clarify
that subscription is via the majordomo address.

We use GitHub Markdown reference [2,3] with trailing empty square
brackets, to match existing text in the file.  On GitHub/GitLab
pages, the footer references matching the empty [] are not shown
on the web page. We could switch to using [text](url) form [1]
if we wanted to, but that is not done as part of this patch.

[1] https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links
[2] https://gist.github.com/ChrisTollefson/a3af6d902a74a0afd1c2d79aadc9bb3f#reference-links
[3] https://github.github.com/gfm/#example-561 (and the para aboveit)

Signed-off-by: Philip Oakley <philipoakley@iee.email>
---
    README.md: add CodingGuidelines and a link for Translators
    
    Also space out the list joining instructions and clarify the
    subscription via the majordomo address.
    
    Signed-off-by: Philip Oakley philipoakley@iee.email
    
    cc: Philip Oakley philipoakley@iee.email cc: Junio C Hamano
    gitster@pobox.com cc: Jiang Xin worldhello.net@gmail.com cc: Bagas
    Sanjaya bagasdotme@gmail.com
    
    changes since V2:
    
     * extended the translation 'messages' description
     * updated commit message based on Junio's suggestion
    
    changes since v1:
    
     * Used reference style links, rather than lnk [url] style.
    
     * added Jiang as L10 coordinator.
    
     * note: Patch is a response to a user question on the "Git for Human
       Beings" git-users list
       https://groups.google.com/d/msgid/git-users/aa68b9c8-4cf4-4193-8af3-79d7e3feafbbn%40googlegroups.com

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1115%2FPhilipOakley%2FReadme-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1115/PhilipOakley/Readme-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/1115

Range-diff vs v2:

 1:  48cc30b7cc8 ! 1:  953a38091ac README.md: add CodingGuidelines and a link for Translators
     @@ Metadata
       ## Commit message ##
          README.md: add CodingGuidelines and a link for Translators
      
     -    The README.md does not use the GitHub Markdown URL links [1] of
     -    [txt](url), rather the reference method [2] of trailing empty square
     -    brackets. The references themselves are listed at the foot of the
     -    document. Those footers are not shown by GitHub/GitLab rendering.
     +    Before being told how to submit patches, new contributors need
     +    to be told how to code for, or how to contribute translation to,
     +    the project.  Add references to the CodingGuidelines and the
     +    README document on localization.
      
     -    Also space out the list joining instructions and clarify that
     -    subscription is via the majordomo address.
     +    Also, split out the instructions to join the list and clarify
     +    that subscription is via the majordomo address.
     +
     +    We use GitHub Markdown reference [2,3] with trailing empty square
     +    brackets, to match existing text in the file.  On GitHub/GitLab
     +    pages, the footer references matching the empty [] are not shown
     +    on the web page. We could switch to using [text](url) form [1]
     +    if we wanted to, but that is not done as part of this patch.
      
          [1] https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links
          [2] https://gist.github.com/ChrisTollefson/a3af6d902a74a0afd1c2d79aadc9bb3f#reference-links
     +    [3] https://github.github.com/gfm/#example-561 (and the para aboveit)
      
          Signed-off-by: Philip Oakley <philipoakley@iee.email>
      
     @@ README.md: installed).
      +[Documentation/SubmittingPatches][] for instructions on patch submission
      +and [Documentation/CodingGuidelines][]).
      +
     -+Those wishing to help with error message translation (localization L10)
     -+should see [po/README.md][] (a `po` file is a Portable Object file that
     -+holds the translations).
     ++Those wishing to help with error message, usage and informational message
     ++string translations (localization l10) should see [po/README.md][]
     ++(a `po` file is a Portable Object file that holds the translations).
      +
       To subscribe to the list, send an email with just "subscribe git" in
      -the body to majordomo@vger.kernel.org. The mailing list archives are
     @@ README.md: and the name as (depending on your mood):
       [Documentation/SubmittingPatches]: Documentation/SubmittingPatches
      +[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
      +[po/README.md]: po/README.md
     - \ No newline at end of file


 README.md | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index f6f43e78deb..7ce4f05bae8 100644
--- a/README.md
+++ b/README.md
@@ -32,10 +32,16 @@ installed).
 The user discussion and development of Git take place on the Git
 mailing list -- everyone is welcome to post bug reports, feature
 requests, comments and patches to git@vger.kernel.org (read
-[Documentation/SubmittingPatches][] for instructions on patch submission).
+[Documentation/SubmittingPatches][] for instructions on patch submission
+and [Documentation/CodingGuidelines][]).
+
+Those wishing to help with error message, usage and informational message
+string translations (localization l10) should see [po/README.md][]
+(a `po` file is a Portable Object file that holds the translations).
+
 To subscribe to the list, send an email with just "subscribe git" in
-the body to majordomo@vger.kernel.org. The mailing list archives are
-available at <https://lore.kernel.org/git/>,
+the body to majordomo@vger.kernel.org (not the Git list). The mailing
+list archives are available at <https://lore.kernel.org/git/>,
 <http://marc.info/?l=git> and other archival sites.
 
 Issues which are security relevant should be disclosed privately to
@@ -64,3 +70,5 @@ and the name as (depending on your mood):
 [Documentation/giteveryday.txt]: Documentation/giteveryday.txt
 [Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
 [Documentation/SubmittingPatches]: Documentation/SubmittingPatches
+[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
+[po/README.md]: po/README.md

base-commit: 1ffcbaa1a5f10c9f706314d77f88de20a4a498c2
-- 
gitgitgadget

^ permalink raw reply	[flat|nested] 11+ messages in thread

* Re: [PATCH v2] README.md: add CodingGuidelines and a link for Translators
  2022-01-17  9:00   ` Bagas Sanjaya
  2022-01-17 17:52     ` Philip Oakley
@ 2022-01-17 18:49     ` Junio C Hamano
  1 sibling, 0 replies; 11+ messages in thread
From: Junio C Hamano @ 2022-01-17 18:49 UTC (permalink / raw)
  To: Bagas Sanjaya; +Cc: Philip Oakley via GitGitGadget, git, Philip Oakley

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> On 16/01/22 23.11, Philip Oakley via GitGitGadget wrote:
>> +Those wishing to help with error message translation (localization L10)
>> +should see [po/README.md][] (a `po` file is a Portable Object file that
>> +holds the translations).
>> +
>
> I mean not just error messages are in po/*.po, but also usage and informational
> strings. We can say "Those wishing to help translating message strings
> (localization or l10n)...".

Yup, that sounds more correct.

Thanks.

^ permalink raw reply	[flat|nested] 11+ messages in thread

end of thread, other threads:[~2022-01-17 18:49 UTC | newest]

Thread overview: 11+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-01-14 17:50 [PATCH] README.md: add CodingGuidelines and a link for Translators Philip Oakley via GitGitGadget
2022-01-14 20:54 ` Junio C Hamano
2022-01-15  0:08   ` Philip Oakley
2022-01-15  0:47     ` Junio C Hamano
2022-01-16 16:11 ` [PATCH v2] " Philip Oakley via GitGitGadget
2022-01-16 22:47   ` Junio C Hamano
2022-01-17 18:08     ` Philip Oakley
2022-01-17  9:00   ` Bagas Sanjaya
2022-01-17 17:52     ` Philip Oakley
2022-01-17 18:49     ` Junio C Hamano
2022-01-17 18:18   ` [PATCH v3] " Philip Oakley via GitGitGadget

Code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).