threads / patch / 38359

patchDocumentation/init-db.txt: minor style and synopsys fixes

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

## tl;dr

3 messages between Jan 14, 2015 and Jan 14, 2015. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

Alexander Kuleshov· Jan 14, 2015, 17:33 UTC · lore

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 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Show changes to Documentation/git-init-db.txt +3 −2

diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt
index 648a6cd..1d94fe8 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
 -----------

-- 
2.3.0.rc0.256.g0057d96

Eric Sunshine· Jan 14, 2015, 20:47 UTC · re: Alexander Kuleshov · lore

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

On Wed, Jan 14, 2015 at 12:33 PM, Alexander Kuleshov <kuleshovmail@gmail.com> wrote:

Show 21 quoted lines

> 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>
> ---
> diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt
> index 648a6cd..1d94fe8 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]

I realize that you copied/pasted the text from git-init.txt, but this should really be [<directory>].

While you're at it, you could fix it in git-init.txt, as well, and adjust the formatting of...

    If you provide a 'directory', ...

to say:

    If you provide <directory>, ...

Alex Henrie· Jan 14, 2015, 21:01 UTC · re: Eric Sunshine · lore

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

2015-01-14 13:47 GMT-07:00 Eric Sunshine <sunshine@sunshineco.com>:

Show 10 quoted lines

> On Wed, Jan 14, 2015 at 12:33 PM, Alexander Kuleshov
> <kuleshovmail@gmail.com> wrote:
>> -'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]
>
> I realize that you copied/pasted the text from git-init.txt, but this
> should really be [<directory>].

We're also transitioning to using hyphens to separate words in template placeholders, so here you would have <template-directory> and <git-dir>.

-Alex