[PATCH v2] Documentation/init-db.txt: minor style and synopsys fixes

[PATCH v2] Documentation/init-db.txt: minor style and synopsys fixes

[Alexander Kuleshov]

This patch constists of two minor changes:

* line-wrap 'git init-db' synopsis

* last possible argument '[<directory>]' was missed

Signed-off-by: Alexander Kuleshov <kuleshovmail@gmail.com>
---
 Documentation/git-init-db.txt | 5 +++--
 Documentation/git-init.txt    | 6 +++---
 2 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt
index 648a6cd..2c77aaa 100644
--- a/Documentation/git-init-db.txt
+++ b/Documentation/git-init-db.txt
@@ -9,8 +9,9 @@ git-init-db - Creates an empty Git repository
 SYNOPSIS
 --------
 [verse]
-'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>] [--separate-git-dir <git dir>] [--shared[=<permissions>]]
-
+'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>]
+	     [--separate-git-dir <git-dir>]
+	     [--shared[=<permissions>]] [<directory>]
 
 DESCRIPTION
 -----------
diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index 369f889..25412ac 100644
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -10,8 +10,8 @@ SYNOPSIS
 --------
 [verse]
 'git init' [-q | --quiet] [--bare] [--template=<template_directory>]
-	  [--separate-git-dir <git dir>]
-	  [--shared[=<permissions>]] [directory]
+	  [--separate-git-dir <git-dir>]
+	  [--shared[=<permissions>]] [<directory>]
 
 
 DESCRIPTION
@@ -108,7 +108,7 @@ By default, the configuration flag `receive.denyNonFastForwards` is enabled
 in shared repositories, so that you cannot force a non fast-forwarding push
 into it.
 
-If you provide a 'directory', the command is run inside it. If this directory
+If you provide a <directory>, the command is run inside it. If this directory
 does not exist, it will be created.
 
 --
-- 
2.3.0.rc0.314.g170a664.dirty

Re: [PATCH v2] Documentation/init-db.txt: minor style and synopsys fixes

[Eric Sunshine]

On Thu, Jan 15, 2015 at 5:31 AM, Alexander Kuleshov
<kuleshovmail@gmail.com> wrote:
> Subject: Documentation/init-db.txt: minor style and synopsys fixes

Subject is incorrect now that you're modifying git-init-db.txt and git-init.txt.

> This patch constists of two minor changes:
>
> * line-wrap 'git init-db' synopsis
>
> * last possible argument '[<directory>]' was missed
>
> Signed-off-by: Alexander Kuleshov <kuleshovmail@gmail.com>
> ---
>  Documentation/git-init-db.txt | 5 +++--
>  Documentation/git-init.txt    | 6 +++---
>  2 files changed, 6 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt
> index 648a6cd..2c77aaa 100644
> --- a/Documentation/git-init-db.txt
> +++ b/Documentation/git-init-db.txt
> @@ -9,8 +9,9 @@ git-init-db - Creates an empty Git repository
>  SYNOPSIS
>  --------
>  [verse]
> -'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>] [--separate-git-dir <git dir>] [--shared[=<permissions>]]
> -
> +'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>]
> +            [--separate-git-dir <git-dir>]
> +            [--shared[=<permissions>]] [<directory>]
>
>  DESCRIPTION
>  -----------
> diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
> index 369f889..25412ac 100644
> --- a/Documentation/git-init.txt
> +++ b/Documentation/git-init.txt
> @@ -10,8 +10,8 @@ SYNOPSIS
>  --------
>  [verse]
>  'git init' [-q | --quiet] [--bare] [--template=<template_directory>]
> -         [--separate-git-dir <git dir>]
> -         [--shared[=<permissions>]] [directory]
> +         [--separate-git-dir <git-dir>]
> +         [--shared[=<permissions>]] [<directory>]
>
>
>  DESCRIPTION
> @@ -108,7 +108,7 @@ By default, the configuration flag `receive.denyNonFastForwards` is enabled
>  in shared repositories, so that you cannot force a non fast-forwarding push
>  into it.
>
> -If you provide a 'directory', the command is run inside it. If this directory
> +If you provide a <directory>, the command is run inside it. If this directory
>  does not exist, it will be created.
>
>  --
> --
> 2.3.0.rc0.314.g170a664.dirty

Re: [PATCH v2] Documentation/init-db.txt: minor style and synopsys fixes

[Alexander Kuleshov]

Yes, right,

how to do it better? Something like: Documentation,
init-db/init:.....? Or something else?

Thank you

2015-01-15 22:50 GMT+06:00 Eric Sunshine <sunshine@sunshineco.com>:
> On Thu, Jan 15, 2015 at 5:31 AM, Alexander Kuleshov
> <kuleshovmail@gmail.com> wrote:
>> Subject: Documentation/init-db.txt: minor style and synopsys fixes
>
> Subject is incorrect now that you're modifying git-init-db.txt and git-init.txt.
>
>> This patch constists of two minor changes:
>>
>> * line-wrap 'git init-db' synopsis
>>
>> * last possible argument '[<directory>]' was missed
>>
>> Signed-off-by: Alexander Kuleshov <kuleshovmail@gmail.com>
>> ---
>>  Documentation/git-init-db.txt | 5 +++--
>>  Documentation/git-init.txt    | 6 +++---
>>  2 files changed, 6 insertions(+), 5 deletions(-)
>>
>> diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt
>> index 648a6cd..2c77aaa 100644
>> --- a/Documentation/git-init-db.txt
>> +++ b/Documentation/git-init-db.txt
>> @@ -9,8 +9,9 @@ git-init-db - Creates an empty Git repository
>>  SYNOPSIS
>>  --------
>>  [verse]
>> -'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>] [--separate-git-dir <git dir>] [--shared[=<permissions>]]
>> -
>> +'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>]
>> +            [--separate-git-dir <git-dir>]
>> +            [--shared[=<permissions>]] [<directory>]
>>
>>  DESCRIPTION
>>  -----------
>> diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
>> index 369f889..25412ac 100644
>> --- a/Documentation/git-init.txt
>> +++ b/Documentation/git-init.txt
>> @@ -10,8 +10,8 @@ SYNOPSIS
>>  --------
>>  [verse]
>>  'git init' [-q | --quiet] [--bare] [--template=<template_directory>]
>> -         [--separate-git-dir <git dir>]
>> -         [--shared[=<permissions>]] [directory]
>> +         [--separate-git-dir <git-dir>]
>> +         [--shared[=<permissions>]] [<directory>]
>>
>>
>>  DESCRIPTION
>> @@ -108,7 +108,7 @@ By default, the configuration flag `receive.denyNonFastForwards` is enabled
>>  in shared repositories, so that you cannot force a non fast-forwarding push
>>  into it.
>>
>> -If you provide a 'directory', the command is run inside it. If this directory
>> +If you provide a <directory>, the command is run inside it. If this directory
>>  does not exist, it will be created.
>>
>>  --
>> --
>> 2.3.0.rc0.314.g170a664.dirty



-- 
_________________________
0xAX

Re: [PATCH v2] Documentation/init-db.txt: minor style and synopsys fixes

[Eric Sunshine]

On Thu, Jan 15, 2015 at 12:08 PM, Alexander Kuleshov
<kuleshovmail@gmail.com> wrote:
> Yes, right,

Etiquette on this list is to avoid top-posting [1].

> how to do it better? Something like: Documentation,
> init-db/init:.....? Or something else?

Simplest would be to split it into two patches: one for
git-init-db.txt and one for git-init.txt.

Also...

>> On Thu, Jan 15, 2015 at 5:31 AM, Alexander Kuleshov
>> <kuleshovmail@gmail.com> wrote:
>>> Subject: Documentation/init-db.txt: minor style and synopsys fixes
>>> This patch constists of two minor changes:
>>>
>>> * line-wrap 'git init-db' synopsis
>>>
>>> * last possible argument '[<directory>]' was missed
>>>
>>> Signed-off-by: Alexander Kuleshov <kuleshovmail@gmail.com>
>>> ---
>>> +'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>]
>>> +            [--separate-git-dir <git-dir>]
>>> +            [--shared[=<permissions>]] [<directory>]

Taking Alex's review[2] into consideration:

s/template_directory/template-directory/

[1]: https://lkml.org/lkml/2005/1/11/111
[2]: http://article.gmane.org/gmane.comp.version-control.git/262427

Re: [PATCH v2] Documentation/init-db.txt: minor style and synopsys fixes

[Junio C Hamano]

Alexander Kuleshov <kuleshovmail@gmail.com> writes:

> Yes, right,
>
> how to do it better? Something like: Documentation,
> init-db/init:.....? Or something else?

Subject: init-db documentation: fix synopsis style

>>> +'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>]

s/_/-/ while we are at it, perhaps?