From 6e1ccacbedf084971f095816f4450c4b607607c5 Mon Sep 17 00:00:00 2001 From: Linus Arver Date: Fri, 8 Aug 2014 10:29:14 -0700 Subject: Documentation: git-init: typographical fixes Use backticks when we quote something that the user should literally use. Signed-off-by: Linus Arver Signed-off-by: Junio C Hamano --- Documentation/git-init.txt | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) (limited to 'Documentation') diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index afd721e3a9..f1f920e0b4 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -43,7 +43,7 @@ OPTIONS -q:: --quiet:: -Only print error and warning messages, all other output will be suppressed. +Only print error and warning messages; all other output will be suppressed. --bare:: @@ -97,7 +97,7 @@ is given: create a repo that is readable and writable to the current user and group, but inaccessible to others. -By default, the configuration flag receive.denyNonFastForwards is enabled +By default, the configuration flag `receive.denyNonFastForwards` is enabled in shared repositories, so that you cannot force a non fast-forwarding push into it. @@ -106,14 +106,13 @@ line, the command is run inside the directory (possibly after creating it). -- - TEMPLATE DIRECTORY ------------------ The template directory contains files and directories that will be copied to the `$GIT_DIR` after it is created. -The template directory used will (in order): +The template directory used will be (in order): - The argument given with the `--template` option. @@ -138,8 +137,8 @@ $ git init <1> $ git add . <2> ---------------- + -<1> prepare /path/to/my/codebase/.git directory -<2> add all existing file to the index +<1> Create a /path/to/my/codebase/.git directory. +<2> Add all existing files to the index. GIT --- -- cgit v1.2.3 From ddeab3aea3c81783b13ff7091552c205d0884675 Mon Sep 17 00:00:00 2001 From: Linus Arver Date: Fri, 8 Aug 2014 10:29:15 -0700 Subject: Documentation: git-init: list items facelift No textual change. Signed-off-by: Linus Arver Signed-off-by: Junio C Hamano --- Documentation/git-init.txt | 49 ++++++++++++++++++++++++++-------------------- 1 file changed, 28 insertions(+), 21 deletions(-) (limited to 'Documentation') diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index f1f920e0b4..c02ccd0b14 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -72,30 +72,37 @@ repository. When specified, the config variable "core.sharedRepository" is set so that files and directories under `$GIT_DIR` are created with the requested permissions. When not specified, Git will use permissions reported by umask(2). - ++ The option can have the following values, defaulting to 'group' if no value is given: ++ +-- +'umask' (or 'false'):: + +Use permissions reported by umask(2). The default, when `--shared` is not +specified. + +'group' (or 'true'):: - - 'umask' (or 'false'): Use permissions reported by umask(2). The default, - when `--shared` is not specified. - - - 'group' (or 'true'): Make the repository group-writable, (and g+sx, since - the git group may be not the primary group of all users). - This is used to loosen the permissions of an otherwise safe umask(2) value. - Note that the umask still applies to the other permission bits (e.g. if - umask is '0022', using 'group' will not remove read privileges from other - (non-group) users). See '0xxx' for how to exactly specify the repository - permissions. - - - 'all' (or 'world' or 'everybody'): Same as 'group', but make the repository - readable by all users. - - - '0xxx': '0xxx' is an octal number and each file will have mode '0xxx'. - '0xxx' will override users' umask(2) value (and not only loosen permissions - as 'group' and 'all' does). '0640' will create a repository which is - group-readable, but not group-writable or accessible to others. '0660' will - create a repo that is readable and writable to the current user and group, - but inaccessible to others. +Make the repository group-writable, (and g+sx, since the git group may be not +the primary group of all users). This is used to loosen the permissions of an +otherwise safe umask(2) value. Note that the umask still applies to the other +permission bits (e.g. if umask is '0022', using 'group' will not remove read +privileges from other (non-group) users). See '0xxx' for how to exactly specify +the repository permissions. + +'all' (or 'world' or 'everybody'):: + +Same as 'group', but make the repository readable by all users. + +'0xxx':: + +'0xxx' is an octal number and each file will have mode '0xxx'. '0xxx' will +override users' umask(2) value (and not only loosen permissions as 'group' and +'all' does). '0640' will create a repository which is group-readable, but not +group-writable or accessible to others. '0660' will create a repo that is +readable and writable to the current user and group, but inaccessible to others. +-- By default, the configuration flag `receive.denyNonFastForwards` is enabled in shared repositories, so that you cannot force a non fast-forwarding push -- cgit v1.2.3 From 86d387af3763e44f8ebdf91e74c37cc002495625 Mon Sep 17 00:00:00 2001 From: Linus Arver Date: Fri, 8 Aug 2014 10:29:16 -0700 Subject: Documentation: git-init: template directory: reword Signed-off-by: Linus Arver Signed-off-by: Junio C Hamano --- Documentation/git-init.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'Documentation') diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index c02ccd0b14..6ffe721ecc 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -119,15 +119,15 @@ TEMPLATE DIRECTORY The template directory contains files and directories that will be copied to the `$GIT_DIR` after it is created. -The template directory used will be (in order): +The template directory will be one of the following (in order): - - The argument given with the `--template` option. + - the argument given with the `--template` option; - - The contents of the `$GIT_TEMPLATE_DIR` environment variable. + - the contents of the `$GIT_TEMPLATE_DIR` environment variable; - - The `init.templatedir` configuration variable. + - the `init.templatedir` configuration variable; or - - The default template directory: `/usr/share/git-core/templates`. + - the default template directory: `/usr/share/git-core/templates`. The default template directory includes some directory structure, some suggested "exclude patterns", and copies of sample "hook" files. -- cgit v1.2.3 From c165d1f5ca82bca5e79a1a797d847ca5458ea9c8 Mon Sep 17 00:00:00 2001 From: Linus Arver Date: Fri, 8 Aug 2014 10:29:17 -0700 Subject: Documentation: git-init: --separate-git-dir: clarify Use shorter sentences to describe what actually happens. We describe what the term "Git symbolic link" actually means. Also, we separate out the description of the behavioral change upon reinitialization into its own paragraph. Signed-off-by: Linus Arver Signed-off-by: Junio C Hamano --- Documentation/git-init.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'Documentation') diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 6ffe721ecc..3f4e46aba4 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -57,12 +57,12 @@ DIRECTORY" section below.) --separate-git-dir=:: -Instead of initializing the repository where it is supposed to be, -place a filesytem-agnostic Git symbolic link there, pointing to the -specified path, and initialize a Git repository at the path. The -result is Git repository can be separated from working tree. If this -is reinitialization, the repository will be moved to the specified -path. +Instead of initializing the repository as a directory to either `$GIT_DIR` or +`./.git/`, create a text file there containing the path to the actual +repository. This file acts as filesystem-agnostic Git symbolic link to the +repository. ++ +If this is reinitialization, the repository will be moved to the specified path. --shared[=(false|true|umask|group|all|world|everybody|0xxx)]:: -- cgit v1.2.3 From 4dde849a20267153aa86ffeb1476cd5886d0fc57 Mon Sep 17 00:00:00 2001 From: Linus Arver Date: Fri, 8 Aug 2014 10:29:18 -0700 Subject: Documentation: git-init: reword parenthetical statements Signed-off-by: Linus Arver Signed-off-by: Junio C Hamano --- Documentation/git-init.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation') diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 3f4e46aba4..21e5ad9cf8 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -108,8 +108,8 @@ 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 name a (possibly non-existent) directory at the end of the command -line, the command is run inside the directory (possibly after creating it). +If you provide a 'directory', the command is run inside it. If this directory +does not exist, it will be created. -- -- cgit v1.2.3 From 8994fbf3ec97d408e2bceefad0328c5951a3de14 Mon Sep 17 00:00:00 2001 From: Linus Arver Date: Fri, 8 Aug 2014 10:29:19 -0700 Subject: Documentation: git-init: template directory: reword and cross-reference Signed-off-by: Linus Arver Signed-off-by: Junio C Hamano --- Documentation/git-init.txt | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'Documentation') diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 21e5ad9cf8..9f2c7d8484 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -129,9 +129,8 @@ The template directory will be one of the following (in order): - the default template directory: `/usr/share/git-core/templates`. -The default template directory includes some directory structure, some -suggested "exclude patterns", and copies of sample "hook" files. -The suggested patterns and hook files are all modifiable and extensible. +The default template directory includes some directory structure, suggested +"exclude patterns" (see linkgit:gitignore[5]), and sample hook files (see linkgit:githooks[5]). EXAMPLES -------- -- cgit v1.2.3 From 64de2e10a0acdcf9558317cca77ed3c5622d7a49 Mon Sep 17 00:00:00 2001 From: Linus Arver Date: Fri, 8 Aug 2014 10:29:20 -0700 Subject: Documentation: git-init: flesh out example Add a third step `git commit` after adding files for the first time. Signed-off-by: Linus Arver Signed-off-by: Junio C Hamano --- Documentation/git-init.txt | 2 ++ 1 file changed, 2 insertions(+) (limited to 'Documentation') diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 9f2c7d8484..369f889bb4 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -141,10 +141,12 @@ Start a new Git repository for an existing code base:: $ cd /path/to/my/codebase $ git init <1> $ git add . <2> +$ git commit <3> ---------------- + <1> Create a /path/to/my/codebase/.git directory. <2> Add all existing files to the index. +<3> Record the pristine state as the first commit in the history. GIT --- -- cgit v1.2.3