git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2] git: update documentation for --git-dir

From
Johannes Sixt <j6t@kdbg.org>
Date
Jan 27, 2020, 06:28 UTC
Message-ID
<b494114d-02ef-599f-4fa0-d7614974a130@kdbg.org>
In-Reply-To
<pull.537.v2.git.1580091855792.gitgitgadget@gmail.com>
Am 27.01.20 um 03:24 schrieb Heba Waly via GitGitGadget:
Show 28 quoted lines
> diff --git a/Documentation/git.txt b/Documentation/git.txt
> index b1597ac002..cf73f501b6 100644
> --- a/Documentation/git.txt
> +++ b/Documentation/git.txt
> @@ -110,9 +110,23 @@ foo.bar= ...`) sets `foo.bar` to the empty string which `git config
>  	Do not pipe Git output into a pager.
>  
>  --git-dir=<path>::
> -	Set the path to the repository. This can also be controlled by
> -	setting the `GIT_DIR` environment variable. It can be an absolute
> -	path or relative path to current working directory.
> +	Set the path to the repository (".git" directory). This can also be
> +	controlled by setting the `GIT_DIR` environment variable. It can be
> +	an absolute path or relative path to current working directory.
> +
> +	Specifying the location of the ".git" directory using this
> +	option (or GIT_DIR environment variable) turns off the
> +	repository discovery that tries to find a directory with
> +	".git" subdirectory (which is how the repository and the
> +	top-level of the working tree are discovered), and tells Git
> +	that you are at the top level of the working tree.  If you
> +	are not at the top-level directory of the working tree, you
> +	should tell Git where the top-level of the working tree is,
> +	with the --work-tree=<path> option (or GIT_WORK_TREE
> +	environment variable)
> +
> +	If you just want to run git as if it was started in <path> then use
> +	git -C.

Does this render well? Judging by the precedent set by the descriptions of -C and -c options earlier in this file, continuation paragraphs should not be indented and separated by a line with just a plus sign instead of an empty line.

-- Hannes
Previous: Heba Waly via GitGitGadgetNext: Heba Waly
Message 9 of 17 in “git: update documentation for --git-dir”
  1. git: update documentation for --git-dirHeba Waly via GitGitGadget, Jan 23, 2020
  2. Heba WalyJan 23, 2020
  3. Emily ShafferJan 23, 2020
  4. Junio C HamanoJan 23, 2020
  5. Junio C HamanoJan 23, 2020
  6. Junio C HamanoJan 23, 2020
  7. Heba WalyJan 27, 2020
  8. git: update documentation for --git-dirHeba Waly via GitGitGadget, Jan 27, 2020
  9. Johannes SixtJan 27, 2020
  10. Heba WalyJan 28, 2020
  11. Jeff KingJan 28, 2020
  12. Heba WalyJan 28, 2020
  13. git: update documentation for --git-dirHeba Waly via GitGitGadget, Jan 28, 2020
  14. Junio C HamanoJan 28, 2020
  15. Heba WalyJan 29, 2020
  16. git: update documentation for --git-dirHeba Waly via GitGitGadget, Jan 30, 2020
  17. Junio C HamanoJan 30, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.