[PATCH 0/3] Documentation: change "folder" to "directory"

[PATCH 0/3] Documentation: change "folder" to "directory"

[Martin Ågren]

It is my understanding that we prefer "directory" over "folder" when
discussing the file system concept. (Whereas "folder" is commonly used
for the GUI view of such a directory, or for an IMAP folder.)

I stumbled on a mention of the ".git folder" when going through the
doc-diff between v2.33.0 and 9d530dc002 ("The fourteenth batch",
2021-10-18), and started looking around. This series is the outcome.

Based on master.

Martin Ågren (3):
  git-multi-pack-index.txt: change "folder" to "directory"
  gitignore.txt: change "folder" to "directory"
  gitweb.txt: change "folder" to "directory"

 Documentation/git-multi-pack-index.txt | 6 +++---
 Documentation/gitignore.txt            | 2 +-
 Documentation/gitweb.txt               | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)

-- 
2.33.1.711.g9d530dc002

[PATCH 1/3] git-multi-pack-index.txt: change "folder" to "directory"

[Martin Ågren]

We prefer "directory" over "folder" when discussing the file system
concept. In all of our documentation, these are the only spots where we
refer to the `.git` directory as a folder. Switch to "directory", and
while doing so, add backticks to the ".git" filename to set it in
monospace.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Documentation/git-multi-pack-index.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-multi-pack-index.txt b/Documentation/git-multi-pack-index.txt
index b008ce2850..c588fb91af 100644
--- a/Documentation/git-multi-pack-index.txt
+++ b/Documentation/git-multi-pack-index.txt
@@ -99,13 +99,13 @@ associated `.keep` file will not be selected for the batch to repack.
 EXAMPLES
 --------
 
-* Write a MIDX file for the packfiles in the current .git folder.
+* Write a MIDX file for the packfiles in the current `.git` directory.
 +
 -----------------------------------------------
 $ git multi-pack-index write
 -----------------------------------------------
 
-* Write a MIDX file for the packfiles in the current .git folder with a
+* Write a MIDX file for the packfiles in the current `.git` directory with a
 corresponding bitmap.
 +
 -------------------------------------------------------------
@@ -118,7 +118,7 @@ $ git multi-pack-index write --preferred-pack=<pack> --bitmap
 $ git multi-pack-index --object-dir <alt> write
 -----------------------------------------------
 
-* Verify the MIDX file for the packfiles in the current .git folder.
+* Verify the MIDX file for the packfiles in the current `.git` directory.
 +
 -----------------------------------------------
 $ git multi-pack-index verify
-- 
2.33.1.711.g9d530dc002

[PATCH 2/3] gitignore.txt: change "folder" to "directory"

[Martin Ågren]

We prefer "directory" over "folder" when discussing the file system
concept. Change this instance for consistency -- indeed, even within
this paragraph, we already use "directory".

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Documentation/gitignore.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
index f8a1fc2014..f2738b10db 100644
--- a/Documentation/gitignore.txt
+++ b/Documentation/gitignore.txt
@@ -155,7 +155,7 @@ accessed from the index or a tree versus from the filesystem.
 EXAMPLES
 --------
 
- - The pattern `hello.*` matches any file or folder
+ - The pattern `hello.*` matches any file or directory
    whose name begins with `hello.`. If one wants to restrict
    this only to the directory and not in its subdirectories,
    one can prepend the pattern with a slash, i.e. `/hello.*`;
-- 
2.33.1.711.g9d530dc002

[PATCH 3/3] gitweb.txt: change "folder" to "directory"

[Martin Ågren]

We prefer "directory" over "folder" when discussing the file system
concept. Change this instance for consistency.

After this, the only hits for '\<folder\>' in Documentation/ relate to
IMAP folders.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Documentation/gitweb.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
index 3cc9b034c4..7cee9d3689 100644
--- a/Documentation/gitweb.txt
+++ b/Documentation/gitweb.txt
@@ -547,7 +547,7 @@ like this:
     # make the front page an internal rewrite to the gitweb script
     RewriteRule ^/$  /cgi-bin/gitweb.cgi  [QSA,L,PT]
 
-    # look for a public_git folder in unix users' home
+    # look for a public_git directory in unix users' home
     # http://git.example.org/~<user>/
     RewriteRule ^/\~([^\/]+)(/|/gitweb.cgi)?$	/cgi-bin/gitweb.cgi \
 		[QSA,E=GITWEB_PROJECTROOT:/home/$1/public_git/,L,PT]
-- 
2.33.1.711.g9d530dc002

Re: [PATCH 0/3] Documentation: change "folder" to "directory"

[Bagas Sanjaya]

On 25/10/21 00.09, Martin Ågren wrote:
> It is my understanding that we prefer "directory" over "folder" when
> discussing the file system concept. (Whereas "folder" is commonly used
> for the GUI view of such a directory, or for an IMAP folder.)
> 
> I stumbled on a mention of the ".git folder" when going through the
> doc-diff between v2.33.0 and 9d530dc002 ("The fourteenth batch",
> 2021-10-18), and started looking around. This series is the outcome.
> 
> Based on master.
> 
> Martin Ågren (3):
>    git-multi-pack-index.txt: change "folder" to "directory"
>    gitignore.txt: change "folder" to "directory"
>    gitweb.txt: change "folder" to "directory"
> 

The same logical change over three patches, why aren't they be squashed 
into single commit?

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

Re: [PATCH 0/3] Documentation: change "folder" to "directory"

[Derrick Stolee]

On 10/24/2021 1:09 PM, Martin Ågren wrote:
> It is my understanding that we prefer "directory" over "folder" when
> discussing the file system concept. (Whereas "folder" is commonly used
> for the GUI view of such a directory, or for an IMAP folder.)
> 
> I stumbled on a mention of the ".git folder" when going through the
> doc-diff between v2.33.0 and 9d530dc002 ("The fourteenth batch",
> 2021-10-18), and started looking around. This series is the outcome.

Thanks for these changes, in particular for the ones that I had
introduced in git-multi-pack-index.txt.

Thanks,
-Stolee

Re: [PATCH 0/3] Documentation: change "folder" to "directory"

[Junio C Hamano]

Martin Ågren <martin.agren@gmail.com> writes:

> It is my understanding that we prefer "directory" over "folder" when
> discussing the file system concept. (Whereas "folder" is commonly used
> for the GUI view of such a directory, or for an IMAP folder.)
>
> I stumbled on a mention of the ".git folder" when going through the
> doc-diff between v2.33.0 and 9d530dc002 ("The fourteenth batch",
> 2021-10-18), and started looking around. This series is the outcome.
>
> Based on master.
>
> Martin Ågren (3):
>   git-multi-pack-index.txt: change "folder" to "directory"
>   gitignore.txt: change "folder" to "directory"
>   gitweb.txt: change "folder" to "directory"

Thanks.  Being consistent is good.

We should have been a bit more careful when we reviewed the changes
that introduced these.

Re: [PATCH 0/3] Documentation: change "folder" to "directory"

[Martin Ågren]

Hi Bagas,

On Mon, 25 Oct 2021 at 11:19, Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>
> On 25/10/21 00.09, Martin Ågren wrote:
> > Martin Ågren (3):
> >    git-multi-pack-index.txt: change "folder" to "directory"
> >    gitignore.txt: change "folder" to "directory"
> >    gitweb.txt: change "folder" to "directory"
> >
>
> The same logical change over three patches, why aren't they be squashed
> into single commit?

Old habit, I guess. :) I tend to find that having multiple patches aids
reviewing. Within reason, obviously. Reviewers don't have to go "I agree
with everything except that particular hunk", but can just say "I agree
with everything except patch two", making tracking things a bit easier.

Similarly, if the patches are all independent (albeit being about the
same topic) and it comes up that a particular patch is not such a good
idea after all because reasons, Junio could just decide to apply a
subset and leave the rest. In this case, the commit message of the third
patch assumes that the first two have already been applied, so they're
not completely independent, but that's about the only interdependency
there is in these.

I'm happy to go either way.

Martin

Re: [PATCH 0/3] Documentation: change "folder" to "directory"

[Junio C Hamano]

Martin Ågren <martin.agren@gmail.com> writes:

> Old habit, I guess. :) I tend to find that having multiple patches aids
> reviewing. Within reason, obviously. Reviewers don't have to go "I agree
> with everything except that particular hunk", but can just say "I agree
> with everything except patch two", making tracking things a bit easier.

In this case, changes to three separate files are presented in three
separate patches, which was a quite pleasant read.  I do appreciate
that you said "within reason" ;-)