threads / patch / 17852

patch, 2 partsModify description file to say what this file is

Subject: [PATCH 1/2] Modify description file to say what this file is

## tl;dr

4 messages between Feb 17, 2009 and Feb 18, 2009. Diffs are folded; open one to read it.

replies: 3people: 2as markdown or json

John Tapsell· Feb 17, 2009, 10:12 UTC · lore

A lot of people see this message for the first time on the gitweb interface, where there is no clue as to what 'this file' means.

Signed-off-by: John Tapsell <johnflux@gmail.com>
---
 templates/hooks--update.sample |    5 +++--
 templates/this--description    |    2 +-
 2 files changed, 4 insertions(+), 3 deletions(-)

Show changes to 2 files +4 −3

templates/hooks--update.sample, templates/this--description

diff --git a/templates/hooks--update.sample b/templates/hooks--update.sample
index 93c6055..f753d28 100755
--- a/templates/hooks--update.sample
+++ b/templates/hooks--update.sample
@@ -43,10 +43,11 @@ allowdeletetag=$(git config --bool hooks.allowdeletetag)
 
 # check for no description
 projectdesc=$(sed -e '1q' "$GIT_DIR/description")
-if [ -z "$projectdesc" -o "$projectdesc" = "Unnamed repository; edit this file to name it for gitweb." ]; then
+case $projectdesc in "Unnamed repository;"*|'')
 	echo "*** Project description file hasn't been set" >&2
 	exit 1
-fi
+	;;
+esac
 
 # --- Check types
 # if $newrev is 0000...0000, it's a commit to delete a ref.
diff --git a/templates/this--description b/templates/this--description
index c6f25e8..914a64e 100644
--- a/templates/this--description
+++ b/templates/this--description
@@ -1 +1 @@
-Unnamed repository; edit this file to name it for gitweb.
+Unnamed repository; edit the .git/description file to name it for gitweb.

-- 
1.6.2.rc1

Junio C Hamano· Feb 17, 2009, 18:39 UTC · re: John Tapsell · lore

Re: [PATCH 1/2] Modify description file to say what this file is

John Tapsell <johnflux@gmail.com> writes:

> A lot of people see this message for the first time on the gitweb
> interface, where there is no clue as to what 'this file' means.
>
> Signed-off-by: John Tapsell <johnflux@gmail.com>

Thanks.

Show 15 quoted lines

> diff --git a/templates/hooks--update.sample b/templates/hooks--update.sample
> index 93c6055..f753d28 100755
> --- a/templates/hooks--update.sample
> +++ b/templates/hooks--update.sample
> @@ -43,10 +43,11 @@ allowdeletetag=$(git config --bool hooks.allowdeletetag)
>  
>  # check for no description
>  projectdesc=$(sed -e '1q' "$GIT_DIR/description")
> -if [ -z "$projectdesc" -o "$projectdesc" = "Unnamed repository; edit this file to name it for gitweb." ]; then
> +case $projectdesc in "Unnamed repository;"*|'')
>  	echo "*** Project description file hasn't been set" >&2
>  	exit 1
> -fi
> +	;;
> +esac

"case" certainly makes it easier to read, but please start a case arm on a fresh line, like this:

	case $projectdesc in
        "Unnamed repository;"* | '')
		echo "*** Project description ..."
		exit 1
		;;
	esac

Show 9 quoted lines

>  # --- Check types
>  # if $newrev is 0000...0000, it's a commit to delete a ref.
> diff --git a/templates/this--description b/templates/this--description
> index c6f25e8..914a64e 100644
> --- a/templates/this--description
> +++ b/templates/this--description
> @@ -1 +1 @@
> -Unnamed repository; edit this file to name it for gitweb.
> +Unnamed repository; edit the .git/description file to name it for gitweb.

I do not have a fundamental objection to this line of changes. If anybody is relying on the exact wording so be it.

But ".git/description" is not typically the user has to edit to remedy this situation, because the primary target for both gitweb and git-push is a bare repository. I think it is better to say "edit the 'description' file to name it for gitweb."

John Tapsell· Feb 17, 2009, 23:31 UTC · re: Junio C Hamano · lore

Re: [PATCH 1/2] Modify description file to say what this file is

2009/2/18 Junio C Hamano <gitster@pobox.com>:

Show 26 quoted lines

> John Tapsell <johnflux@gmail.com> writes:
>
>> A lot of people see this message for the first time on the gitweb
>> interface, where there is no clue as to what 'this file' means.
>>
>> Signed-off-by: John Tapsell <johnflux@gmail.com>
>
> Thanks.
>
>> diff --git a/templates/hooks--update.sample b/templates/hooks--update.sample
>> index 93c6055..f753d28 100755
>> --- a/templates/hooks--update.sample
>> +++ b/templates/hooks--update.sample
>> @@ -43,10 +43,11 @@ allowdeletetag=$(git config --bool hooks.allowdeletetag)
>>
>>  # check for no description
>>  projectdesc=$(sed -e '1q' "$GIT_DIR/description")
>> -if [ -z "$projectdesc" -o "$projectdesc" = "Unnamed repository; edit this file to name it for gitweb." ]; then
>> +case $projectdesc in "Unnamed repository;"*|'')
>>       echo "*** Project description file hasn't been set" >&2
>>       exit 1
>> -fi
>> +     ;;
>> +esac
>
> "case" certainly makes it easier to read,

Using case is a 'hack' to let me check if a string begins with another string, in a way that works in all shells (i.e. without bash manarisims)

Show 26 quoted lines

> but please start a case arm on a fresh line, like this:
>
>        case $projectdesc in
>        "Unnamed repository;"* | '')
>                echo "*** Project description ..."
>                exit 1
>                ;;
>        esac
>
>>  # --- Check types
>>  # if $newrev is 0000...0000, it's a commit to delete a ref.
>> diff --git a/templates/this--description b/templates/this--description
>> index c6f25e8..914a64e 100644
>> --- a/templates/this--description
>> +++ b/templates/this--description
>> @@ -1 +1 @@
>> -Unnamed repository; edit this file to name it for gitweb.
>> +Unnamed repository; edit the .git/description file to name it for gitweb.
>
> I do not have a fundamental objection to this line of changes.  If anybody
> is relying on the exact wording so be it.
>
> But ".git/description" is not typically the user has to edit to remedy
> this situation, because the primary target for both gitweb and git-push is
> a bare repository.  I think it is better to say "edit the 'description'
> file to name it for gitweb."

Btw, google seems to show other programs using the description file, not just gitweb. How about changing it to "Unnamed repository: edit the file 'description' to name the repository" ?

Junio C Hamano· Feb 18, 2009, 00:16 UTC · re: John Tapsell · lore

Re: [PATCH 1/2] Modify description file to say what this file is

John Tapsell <johnflux@gmail.com> writes:

Show 5 quoted lines

> 2009/2/18 Junio C Hamano <gitster@pobox.com>:
>
> Btw, google seems to show other programs using the description file,
> not just gitweb.  How about changing it to "Unnamed repository: edit
> the file 'description' to name the repository" ?

Sure.

I also think "edit this file 'description' to name..." (not "the", but "this") would give a bit more hint to a user with a better intuition that the message is not something that is given by an individual program (e.g. gitweb or the sample hook) but is a product of catting a file that exists somewhere in the repository in question, and may reduce unnecessary requests for help saying "The program tells me to edit 'description' file, but where should I *create* one?"