Skip to contentSkip to conversation

minor diff between gitweb docs and actual template for $GIT/description

PATCH In review Tim Chase 2 participants 3 messages Jun 15, 2016 Documentation

lore
Share & tools
lore

Tim Chase

author
#0 lore raw

PATCH 1/1 minor diff between gitweb docs and actual template for $GIT/description

The documentation for gitweb gives one description of the default content for the $GIT/description, the description template has other text. One of these two patches should be applied to bring them into order (applying both would just reverse the problem). Or, both could be changed to the same new text.

-tkc
(not subscribed to the actual git ML, just [email protected])

Documentation/gitweb.txt +1 -1
index 168e8bf..7c4cb69 100644
@@ -227,7 +227,7 @@ description (or `gitweb.description`)::
 	repository).  Plain text file; HTML will be escaped.  By default set to
 +
 -------------------------------------------------------------------------------
-Unnamed repository; edit this file to name it for gitweb.
+Unnamed repository; edit this file 'description' to name the repository.
 -------------------------------------------------------------------------------
 +
 from the template during repository creation, usually installed in
templates/this--description +1 -1
index 498b267..c6f25e8 100644
@@ -1 +1 @@
-Unnamed repository; edit this file 'description' to name the repository.
+Unnamed repository; edit this file to name it for gitweb.
#1 lore raw

(+cc: Jakub, who maintains gitweb)
Hi Tim,

Quoted 5 lines · Tim Chase

The documentation for gitweb gives one description of the default content for the $GIT/description, the description template has other text. One of these two patches should be applied to bring them into order (applying both would just reverse the problem). Or, both could be changed to the same new text.

May we have your sign-off? (See Documentation/SubmittingPatches for what this means.)

Documentation/gitweb.txt description (or `gitweb.description`):: · line 233

Quoted 11 lines
Documentation/gitweb.txt +1 -1
@@ -227,7 +227,7 @@ description (or `gitweb.description`)::
 	repository).  Plain text file; HTML will be escaped.  By default set to
 +
 -------------------------------------------------------------------------------
-Unnamed repository; edit this file to name it for gitweb.
+Unnamed repository; edit this file 'description' to name the repository.
 -------------------------------------------------------------------------------
 +
 from the template during repository creation, usually installed in

Looks sane to me. Thanks for noticing.

Regards,
Jonathan

author
#2 lore raw
Quoted 5 lines · Jonathan Nieder

(+cc: Jakub, who maintains gitweb)
Hi Tim,

Tim Chase wrote:

Quoted 8 lines
Quoted 5 lines

The documentation for gitweb gives one description of the default content for the $GIT/description, the description template has other text. One of these two patches should be applied to bring them into order (applying both would just reverse the problem). Or, both could be changed to the same new text.

May we have your sign-off? (See Documentation/SubmittingPatches for what this means.)

Hahahahah...a one liner doc-fix copy/pasting code from one place in the codebase to another? If you need it, you've got it:

For my one line diff:

Otherwise, consider my contribution CC0 or public domain or whatever suits you best. Or take my patch as a bug report and "make" the fix yourself. :-)

The patches should have been based off the master branch of github.com/git/git, FWIW.

-tkc
@gumnos