[PATCH] Some Documentation Changes

[PATCH] Some Documentation Changes

[jamie.couture]

Hi,

Here are a series of patches to correct some spelling and grammar in the
documentation.

I've also created a section for deprecated options, and removed the
functionality for 'index-header' and 'index-info'.  I'm not sure how well a few
of these will be received, since I'm not sure when cgit is planning on bumping
to v1.0.

I broke the changes up as much as I could.

--
Jamie

[PATCH 1/8] cgitrc.5.txt: move deprecated options

[jamie.couture]

Create a section for deprecated options.  Avoid cluttering manual with
ignored options.

Signed-off-by: Jamie Couture <jamie.couture at gmail.com>
---
 cgitrc.5.txt |   47 ++++++++++++++++++++++++++---------------------
 1 file changed, 26 insertions(+), 21 deletions(-)

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index a72241f..971d960 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -168,18 +168,6 @@ include::
 	Name of a configfile to include before the rest of the current config-
 	file is parsed. Default value: none. See also: "MACRO EXPANSION".
 
-index-header::
-	The content of the file specified with this option will be included
-	verbatim above the repository index. This setting is deprecated, and
-	will not be supported by cgit-1.0 (use root-readme instead). Default
-	value: none.
-
-index-info::
-	The content of the file specified with this option will be included
-	verbatim below the heading on the repository index page. This setting
-	is deprecated, and will not be supported by cgit-1.0 (use root-desc
-	instead). Default value: none.
-
 local-time::
 	Flag which, if set to "1", makes cgit print commit and tag times in the
 	servers timezone. Default value: "0".
@@ -243,11 +231,6 @@ module-link::
 	formatstring are the path and SHA1 of the submodule commit. Default
 	value: none.
 
-nocache::
-	If set to the value "1" caching will be disabled. This settings is
-	deprecated, and will not be honored starting with cgit-1.0. Default
-	value: "0".
-
 noplainemail::
 	If set to "1" showing full author email adresses will be disabled.
 	Default value: "0".
@@ -276,10 +259,6 @@ renamelimit::
 	 "-1" uses the compiletime value in git (for further info, look at
 	  `man git-diff`). Default value: "-1".
 
-repo.group::
-	Legacy alias for "section". This option is deprecated and will not be
-	supported in cgit-1.0.
-
 robots::
 	Text used as content for the "robots" meta-tag. Default value:
 	"index, nofollow".
@@ -474,6 +453,32 @@ repo.url::
 	setting specified for each repo. Default value: none.
 
 
+DEPRECATED OPTIONS
+------------------
+
+index-header::
+	The content of the file specified with this option will be included
+	verbatim above the repository index. This setting is deprecated, and
+	will not be supported by cgit-1.0 (use root-readme instead). Default
+	value: none.
+
+index-info::
+	The content of the file specified with this option will be included
+	verbatim below the heading on the repository index page. This setting
+	is deprecated, and will not be supported by cgit-1.0 (use root-desc
+	instead). Default value: none.
+
+nocache::
+	If set to the value "1" caching will be disabled. This settings is
+	deprecated, and will not be honored starting with cgit-1.0. Default
+	value: "0".
+
+repo.group::
+	Legacy alias for "section". This option is deprecated and will not be
+	supported in cgit-1.0.
+
+
+
 REPOSITORY-SPECIFIC CGITRC FILE
 -------------------------------
 When the option "scan-path" is used to auto-discover git repositories, cgit
-- 
1.7.9.3

[PATCH 2/8] changed wording of deprecated options

[jamie.couture]

Signed-off-by: Jamie Couture <jamie.couture at gmail.com>
---
 cgitrc.5.txt |   23 +++++++++--------------
 1 file changed, 9 insertions(+), 14 deletions(-)

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 971d960..2329087 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -457,26 +457,21 @@ DEPRECATED OPTIONS
 ------------------
 
 index-header::
-	The content of the file specified with this option will be included
-	verbatim above the repository index. This setting is deprecated, and
-	will not be supported by cgit-1.0 (use root-readme instead). Default
-	value: none.
+	Use `root-readme` instead. Deprecated since _v1.0_. The content of the
+	file specified with this option will be included verbatim above the
+	repository index. Default value: none.
 
 index-info::
-	The content of the file specified with this option will be included
-	verbatim below the heading on the repository index page. This setting
-	is deprecated, and will not be supported by cgit-1.0 (use root-desc
-	instead). Default value: none.
+	Use `root-desc` instead. Deprecated since _v1.0_. The content of the file
+	specified with this option will be included verbatim below the heading on
+	the repository index page. Default value: none.
 
 nocache::
-	If set to the value "1" caching will be disabled. This settings is
-	deprecated, and will not be honored starting with cgit-1.0. Default
-	value: "0".
+	Deprecated since _v1.0_. If set to the value "1" caching will be
+	disabled. Default value: "0".
 
 repo.group::
-	Legacy alias for "section". This option is deprecated and will not be
-	supported in cgit-1.0.
-
+	Deprecated since _v1.0_. Legacy alias for "section".
 
 
 REPOSITORY-SPECIFIC CGITRC FILE
-- 
1.7.9.3

[PATCH 3/8] deprecate option index-header

[jamie.couture]

use root-readme instead of index-header

Signed-off-by: Jamie Couture <jamie.couture at gmail.com>
---
 cgit.c        |    2 --
 cgit.h        |    1 -
 ui-repolist.c |    3 ---
 3 files changed, 6 deletions(-)

diff --git a/cgit.c b/cgit.c
index b9b3a66..17f6be0 100644
--- a/cgit.c
+++ b/cgit.c
@@ -139,8 +139,6 @@ void config_cb(const char *name, const char *value)
 		ctx.cfg.header = xstrdup(value);
 	else if (!strcmp(name, "logo"))
 		ctx.cfg.logo = xstrdup(value);
-	else if (!strcmp(name, "index-header"))
-		ctx.cfg.index_header = xstrdup(value);
 	else if (!strcmp(name, "index-info"))
 		ctx.cfg.index_info = xstrdup(value);
 	else if (!strcmp(name, "logo-link"))
diff --git a/cgit.h b/cgit.h
index 6ee6769..a8ec5ca 100644
--- a/cgit.h
+++ b/cgit.h
@@ -173,7 +173,6 @@ struct cgit_config {
 	char *footer;
 	char *head_include;
 	char *header;
-	char *index_header;
 	char *index_info;
 	char *logo;
 	char *logo_link;
diff --git a/ui-repolist.c b/ui-repolist.c
index d946f32..325b1ae 100644
--- a/ui-repolist.c
+++ b/ui-repolist.c
@@ -232,9 +232,6 @@ void cgit_print_repolist()
 	cgit_print_docstart(&ctx);
 	cgit_print_pageheader(&ctx);
 
-	if (ctx.cfg.index_header)
-		html_include(ctx.cfg.index_header);
-
 	if(ctx.qry.sort)
 		sorted = sort_repolist(ctx.qry.sort);
 	else
-- 
1.7.9.3

[PATCH 4/8] deprecate option index-info

[jamie.couture]

use root-desc instead of index-info

Signed-off-by: Jamie Couture <jamie.couture at gmail.com>
---
 cgit.c      |    2 --
 cgit.h      |    1 -
 ui-shared.c |    2 --
 3 files changed, 5 deletions(-)

diff --git a/cgit.c b/cgit.c
index 17f6be0..1661f63 100644
--- a/cgit.c
+++ b/cgit.c
@@ -139,8 +139,6 @@ void config_cb(const char *name, const char *value)
 		ctx.cfg.header = xstrdup(value);
 	else if (!strcmp(name, "logo"))
 		ctx.cfg.logo = xstrdup(value);
-	else if (!strcmp(name, "index-info"))
-		ctx.cfg.index_info = xstrdup(value);
 	else if (!strcmp(name, "logo-link"))
 		ctx.cfg.logo_link = xstrdup(value);
 	else if (!strcmp(name, "module-link"))
diff --git a/cgit.h b/cgit.h
index a8ec5ca..da86315 100644
--- a/cgit.h
+++ b/cgit.h
@@ -173,7 +173,6 @@ struct cgit_config {
 	char *footer;
 	char *head_include;
 	char *header;
-	char *index_info;
 	char *logo;
 	char *logo_link;
 	char *mimetype_file;
diff --git a/ui-shared.c b/ui-shared.c
index 43166af..ecabbe5 100644
--- a/ui-shared.c
+++ b/ui-shared.c
@@ -867,8 +867,6 @@ static void print_header(struct cgit_context *ctx)
 	} else {
 		if (ctx->cfg.root_desc)
 			html_txt(ctx->cfg.root_desc);
-		else if (ctx->cfg.index_info)
-			html_include(ctx->cfg.index_info);
 	}
 	html("</td></tr></table>\n");
 }
-- 
1.7.9.3

[PATCH 5/8] cgitrc.5.txt: change 'formatstring' to two words

[jamie.couture]

Signed-off-by: Jamie Couture <jamie.couture at gmail.com>
---
 cgitrc.5.txt |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index a72241f..517266b 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -238,7 +238,7 @@ mimetype-file::
 	  by one or more file extensions (like jpg), all separated by whitespace
 
 module-link::
-	Text which will be used as the formatstring for a hyperlink when a
+	Text which will be used as the format string for a hyperlink when a
 	submodule is printed in a directory listing. The arguments for the
 	formatstring are the path and SHA1 of the submodule commit. Default
 	value: none.
@@ -424,9 +424,9 @@ repo.logo-link::
 	value: global logo-link.
 
 repo.module-link::
-	Text which will be used as the formatstring for a hyperlink when a
+	Text which will be used as the format string for a hyperlink when a
 	submodule is printed in a directory listing. The arguments for the
-	formatstring are the path and SHA1 of the submodule commit. Default
+	format string are the path and SHA1 of the submodule commit. Default
 	value: <module-link>
 
 repo.module-link.<path>::
-- 
1.7.9.3

[PATCH 6/8] cgitrc.5.txt: correct a few typos

[jamie.couture]

Signed-off-by: Jamie Couture <jamie.couture at gmail.com>
---
 cgitrc.5.txt |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 517266b..36c9644 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -249,7 +249,7 @@ nocache::
 	value: "0".
 
 noplainemail::
-	If set to "1" showing full author email adresses will be disabled.
+	If set to "1" showing full author email addresses will be disabled.
 	Default value: "0".
 
 noheader::
@@ -524,7 +524,7 @@ environment variable will be unset.
 MACRO EXPANSION
 ---------------
 The following cgitrc options supports a simple macro expansion feature,
-where tokens prefixed with "$" are replaced with the value of a similary
+where tokens prefixed with "$" are replaced with the value of a similarly
 named environment variable:
 
 - cache-root
@@ -551,7 +551,7 @@ EXAMPLE CGITRC FILE
 -------------------
 
 ....
-# Enable caching of up to 1000 output entriess
+# Enable caching of up to 1000 output entries
 cache-size=1000
 
 
-- 
1.7.9.3

[PATCH 7/8] correct usage of 'webinterface'

[jamie.couture]

should be two words

Signed-off-by: Jamie Couture <jamie.couture at gmail.com>
---
 cgit.c       |    2 +-
 cgitrc.5.txt |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/cgit.c b/cgit.c
index b9b3a66..68ff50d 100644
--- a/cgit.c
+++ b/cgit.c
@@ -351,7 +351,7 @@ static void prepare_context(struct cgit_context *ctx)
 	ctx->cfg.remove_suffix = 0;
 	ctx->cfg.robots = "index, nofollow";
 	ctx->cfg.root_title = "Git repository browser";
-	ctx->cfg.root_desc = "a fast webinterface for the git dscm";
+	ctx->cfg.root_desc = "a fast web interface for the git dscm";
 	ctx->cfg.scan_hidden_path = 0;
 	ctx->cfg.script_name = CGIT_SCRIPT_NAME;
 	ctx->cfg.section = "";
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 36c9644..b5852fc 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -286,7 +286,7 @@ robots::
 
 root-desc::
 	Text printed below the heading on the repository index page. Default
-	value: "a fast webinterface for the git dscm".
+	value: "a fast web interface for the git dscm".
 
 root-readme::
 	The content of the file specified with this option will be included
-- 
1.7.9.3

[PATCH 8/8] cgitrc.5.txt: one vs. two word changes

[jamie.couture]

split a few words into two, or hyphenated where it made sense

Signed-off-by: Jamie Couture <jamie.couture at gmail.com>
---
 cgitrc.5.txt |   16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index b5852fc..2b7d427 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -85,7 +85,7 @@ commit-filter::
 	Specifies a command which will be invoked to format commit messages.
 	The command will get the message on its STDIN, and the STDOUT from the
 	command will be included verbatim as the commit message, i.e. this can
-	be used to implement bugtracker integration. Default value: none.
+	be used to implement bug tracker integration. Default value: none.
 	See also: "FILTER API".
 
 css::
@@ -143,8 +143,8 @@ enable-subject-links::
 	"repo.enable-subject-links".
 
 enable-tree-linenumbers::
-	Flag which, when set to "1", will make cgit generate linenumber links
-	for plaintext blobs printed in the tree view. Default value: "1".
+	Flag which, when set to "1", will make cgit generate line number links
+	for plain text blobs printed in the tree view. Default value: "1".
 
 favicon::
 	Url used as link to a shortcut icon for cgit. If specified, it is
@@ -165,7 +165,7 @@ header::
 	verbatim at the top of all pages. Default value: none.
 
 include::
-	Name of a configfile to include before the rest of the current config-
+	Name of a config-file to include before the rest of the current config-
 	file is parsed. Default value: none. See also: "MACRO EXPANSION".
 
 index-header::
@@ -223,7 +223,7 @@ max-stats::
 	disabled. Default value: none. See also: "repo.max-stats".
 
 mimetype.<ext>::
-	Set the mimetype for the specified filename extension. This is used
+	Set the mime-type for the specified filename extension. This is used
 	by the `plain` command when returning blob content.
 
 mimetype-file::
@@ -273,7 +273,7 @@ remove-suffix::
 
 renamelimit::
 	Maximum number of files to consider when detecting renames. The value
-	 "-1" uses the compiletime value in git (for further info, look at
+	 "-1" uses the compile time value in git (for further info, look at
 	  `man git-diff`). Default value: "-1".
 
 repo.group::
@@ -306,7 +306,7 @@ scan-hidden-path::
 	Default value: 0. See also: scan-path.
 
 scan-path::
-	A path which will be scanned for repositories. If caching is enabled,
+	A path scanned for repositories. If caching is enabled,
 	the result will be cached as a cgitrc include-file in the cache
 	directory. If project-list has been defined prior to scan-path,
 	scan-path loads only the directories listed in the file pointed to by
@@ -337,7 +337,7 @@ snapshots::
 	none.
 
 source-filter::
-	Specifies a command which will be invoked to format plaintext blobs
+	Specifies a command which will be invoked to format plain text blobs
 	in the tree view. The command will get the blob content on its STDIN
 	and the name of the blob as its only command line argument. The STDOUT
 	from the command will be included verbatim as the blob contents, i.e.
-- 
1.7.9.3

[PATCH 1/8] cgitrc.5.txt: move deprecated options

[mailings]

On 21-03-12 02:07, Jamie Couture wrote:
> Create a section for deprecated options.  Avoid cluttering manual with
> ignored options.
>
> Signed-off-by: Jamie Couture<jamie.couture at gmail.com>

Reviewed-by: Ferry Huberts <ferry.huberts at pelagic.nl>

> ---
>   cgitrc.5.txt |   47 ++++++++++++++++++++++++++---------------------
>   1 file changed, 26 insertions(+), 21 deletions(-)
>
> diff --git a/cgitrc.5.txt b/cgitrc.5.txt
> index a72241f..971d960 100644
> --- a/cgitrc.5.txt
> +++ b/cgitrc.5.txt
> @@ -168,18 +168,6 @@ include::
>   	Name of a configfile to include before the rest of the current config-
>   	file is parsed. Default value: none. See also: "MACRO EXPANSION".
>
> -index-header::
> -	The content of the file specified with this option will be included
> -	verbatim above the repository index. This setting is deprecated, and
> -	will not be supported by cgit-1.0 (use root-readme instead). Default
> -	value: none.
> -
> -index-info::
> -	The content of the file specified with this option will be included
> -	verbatim below the heading on the repository index page. This setting
> -	is deprecated, and will not be supported by cgit-1.0 (use root-desc
> -	instead). Default value: none.
> -
>   local-time::
>   	Flag which, if set to "1", makes cgit print commit and tag times in the
>   	servers timezone. Default value: "0".
> @@ -243,11 +231,6 @@ module-link::
>   	formatstring are the path and SHA1 of the submodule commit. Default
>   	value: none.
>
> -nocache::
> -	If set to the value "1" caching will be disabled. This settings is
> -	deprecated, and will not be honored starting with cgit-1.0. Default
> -	value: "0".
> -
>   noplainemail::
>   	If set to "1" showing full author email adresses will be disabled.
>   	Default value: "0".
> @@ -276,10 +259,6 @@ renamelimit::
>   	 "-1" uses the compiletime value in git (for further info, look at
>   	  `man git-diff`). Default value: "-1".
>
> -repo.group::
> -	Legacy alias for "section". This option is deprecated and will not be
> -	supported in cgit-1.0.
> -
>   robots::
>   	Text used as content for the "robots" meta-tag. Default value:
>   	"index, nofollow".
> @@ -474,6 +453,32 @@ repo.url::
>   	setting specified for each repo. Default value: none.
>
>
> +DEPRECATED OPTIONS
> +------------------
> +
> +index-header::
> +	The content of the file specified with this option will be included
> +	verbatim above the repository index. This setting is deprecated, and
> +	will not be supported by cgit-1.0 (use root-readme instead). Default
> +	value: none.
> +
> +index-info::
> +	The content of the file specified with this option will be included
> +	verbatim below the heading on the repository index page. This setting
> +	is deprecated, and will not be supported by cgit-1.0 (use root-desc
> +	instead). Default value: none.
> +
> +nocache::
> +	If set to the value "1" caching will be disabled. This settings is
> +	deprecated, and will not be honored starting with cgit-1.0. Default
> +	value: "0".
> +
> +repo.group::
> +	Legacy alias for "section". This option is deprecated and will not be
> +	supported in cgit-1.0.
> +
> +
> +
>   REPOSITORY-SPECIFIC CGITRC FILE
>   -------------------------------
>   When the option "scan-path" is used to auto-discover git repositories, cgit

-- 
Ferry Huberts

[PATCH 2/8] changed wording of deprecated options

[mailings]

On 21-03-12 02:07, Jamie Couture wrote:
> Signed-off-by: Jamie Couture<jamie.couture at gmail.com>
> ---
>   cgitrc.5.txt |   23 +++++++++--------------
>   1 file changed, 9 insertions(+), 14 deletions(-)
>
> diff --git a/cgitrc.5.txt b/cgitrc.5.txt
> index 971d960..2329087 100644
> --- a/cgitrc.5.txt
> +++ b/cgitrc.5.txt
> @@ -457,26 +457,21 @@ DEPRECATED OPTIONS
>   ------------------
>
>   index-header::
> -	The content of the file specified with this option will be included
> -	verbatim above the repository index. This setting is deprecated, and
> -	will not be supported by cgit-1.0 (use root-readme instead). Default
> -	value: none.
> +	Use `root-readme` instead. Deprecated since _v1.0_. The content of the
> +	file specified with this option will be included verbatim above the
> +	repository index. Default value: none.
>   

I think you didn't read it well enough :-)
The option is deprecated _now_, and _unsupported_ in 1.0

Same for the other options, so no need to change the texts IMHO


>   index-info::
> -	The content of the file specified with this option will be included
> -	verbatim below the heading on the repository index page. This setting
> -	is deprecated, and will not be supported by cgit-1.0 (use root-desc
> -	instead). Default value: none.
> +	Use `root-desc` instead. Deprecated since _v1.0_. The content of the file
> +	specified with this option will be included verbatim below the heading on
> +	the repository index page. Default value: none.
>
>   nocache::
> -	If set to the value "1" caching will be disabled. This settings is
> -	deprecated, and will not be honored starting with cgit-1.0. Default
> -	value: "0".
> +	Deprecated since _v1.0_. If set to the value "1" caching will be
> +	disabled. Default value: "0".
>
>   repo.group::
> -	Legacy alias for "section". This option is deprecated and will not be
> -	supported in cgit-1.0.
> -
> +	Deprecated since _v1.0_. Legacy alias for "section".
>
>
>   REPOSITORY-SPECIFIC CGITRC FILE

-- 
Ferry Huberts

[PATCH 5/8] cgitrc.5.txt: change 'formatstring' to two words

[mailings]

On 21-03-12 02:07, Jamie Couture wrote:
> Signed-off-by: Jamie Couture<jamie.couture at gmail.com>

Reviewed-by: Ferry Huberts <ferry.huberts at pelagic.nl>

> ---
>   cgitrc.5.txt |    6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/cgitrc.5.txt b/cgitrc.5.txt
> index a72241f..517266b 100644
> --- a/cgitrc.5.txt
> +++ b/cgitrc.5.txt
> @@ -238,7 +238,7 @@ mimetype-file::
>   	  by one or more file extensions (like jpg), all separated by whitespace
>
>   module-link::
> -	Text which will be used as the formatstring for a hyperlink when a
> +	Text which will be used as the format string for a hyperlink when a
>   	submodule is printed in a directory listing. The arguments for the
>   	formatstring are the path and SHA1 of the submodule commit. Default
>   	value: none.
> @@ -424,9 +424,9 @@ repo.logo-link::
>   	value: global logo-link.
>
>   repo.module-link::
> -	Text which will be used as the formatstring for a hyperlink when a
> +	Text which will be used as the format string for a hyperlink when a
>   	submodule is printed in a directory listing. The arguments for the
> -	formatstring are the path and SHA1 of the submodule commit. Default
> +	format string are the path and SHA1 of the submodule commit. Default
>   	value:<module-link>
>
>   repo.module-link.<path>::

-- 
Ferry Huberts

[PATCH 6/8] cgitrc.5.txt: correct a few typos

[mailings]

On 21-03-12 02:07, Jamie Couture wrote:
> Signed-off-by: Jamie Couture<jamie.couture at gmail.com>

Reviewed-by: Ferry Huberts <ferry.huberts at pelagic.nl>
> ---
>   cgitrc.5.txt |    6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/cgitrc.5.txt b/cgitrc.5.txt
> index 517266b..36c9644 100644
> --- a/cgitrc.5.txt
> +++ b/cgitrc.5.txt
> @@ -249,7 +249,7 @@ nocache::
>   	value: "0".
>
>   noplainemail::
> -	If set to "1" showing full author email adresses will be disabled.
> +	If set to "1" showing full author email addresses will be disabled.
>   	Default value: "0".
>
>   noheader::
> @@ -524,7 +524,7 @@ environment variable will be unset.
>   MACRO EXPANSION
>   ---------------
>   The following cgitrc options supports a simple macro expansion feature,
> -where tokens prefixed with "$" are replaced with the value of a similary
> +where tokens prefixed with "$" are replaced with the value of a similarly
>   named environment variable:
>
>   - cache-root
> @@ -551,7 +551,7 @@ EXAMPLE CGITRC FILE
>   -------------------
>
>   ....
> -# Enable caching of up to 1000 output entriess
> +# Enable caching of up to 1000 output entries
>   cache-size=1000
>
>

-- 
Ferry Huberts

[PATCH 7/8] correct usage of 'webinterface'

[mailings]

On 21-03-12 02:07, Jamie Couture wrote:
> should be two words
>
> Signed-off-by: Jamie Couture<jamie.couture at gmail.com>

Reviewed-by: Ferry Huberts <ferry.huberts at pelagic.nl>
> ---
>   cgit.c       |    2 +-
>   cgitrc.5.txt |    2 +-
>   2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/cgit.c b/cgit.c
> index b9b3a66..68ff50d 100644
> --- a/cgit.c
> +++ b/cgit.c
> @@ -351,7 +351,7 @@ static void prepare_context(struct cgit_context *ctx)
>   	ctx->cfg.remove_suffix = 0;
>   	ctx->cfg.robots = "index, nofollow";
>   	ctx->cfg.root_title = "Git repository browser";
> -	ctx->cfg.root_desc = "a fast webinterface for the git dscm";
> +	ctx->cfg.root_desc = "a fast web interface for the git dscm";
>   	ctx->cfg.scan_hidden_path = 0;
>   	ctx->cfg.script_name = CGIT_SCRIPT_NAME;
>   	ctx->cfg.section = "";
> diff --git a/cgitrc.5.txt b/cgitrc.5.txt
> index 36c9644..b5852fc 100644
> --- a/cgitrc.5.txt
> +++ b/cgitrc.5.txt
> @@ -286,7 +286,7 @@ robots::
>
>   root-desc::
>   	Text printed below the heading on the repository index page. Default
> -	value: "a fast webinterface for the git dscm".
> +	value: "a fast web interface for the git dscm".
>
>   root-readme::
>   	The content of the file specified with this option will be included

-- 
Ferry Huberts

[PATCH] Some Documentation Changes

[mailings]

I only received patches 1,2,5,6 and 7. The other ones are missing in my 
inbox.
I've seen this behaviour before, Lars can you check your mailer?




On 21-03-12 02:07, Jamie Couture wrote:
> Hi,
>
> Here are a series of patches to correct some spelling and grammar in the
> documentation.
>
> I've also created a section for deprecated options, and removed the
> functionality for 'index-header' and 'index-info'.  I'm not sure how well a few
> of these will be received, since I'm not sure when cgit is planning on bumping
> to v1.0.
>
> I broke the changes up as much as I could.
>
> --
> Jamie
>
>
> _______________________________________________
> cgit mailing list
> cgit at hjemli.net
> http://hjemli.net/mailman/listinfo/cgit

-- 
Ferry Huberts

[PATCH] Some Documentation Changes

[mailings]

On 21-03-12 09:27, larsh at hjemli.net wrote:
> On Wed, Mar 21, 2012 at 08:19:18AM +0100, Ferry Huberts wrote:
>> I only received patches 1,2,5,6 and 7. The other ones are missing in my
>> inbox.
>> I've seen this behaviour before, Lars can you check your mailer?
> A quick grep of the exim mainlog:
>
> 2012-03-21 01:17:29 1SAAB5-0005LL-HI == mailings at hupie.com R=dnslookup T=remote_smtp defer (111): Connection refused
> 2012-03-21 01:17:29 1SAAB7-0005M0-Ju == mailings at hupie.com R=dnslookup T=remote_smtp defer (111): Connection refused
> 2012-03-21 01:17:30 1SAAB7-0005M7-LM == mailings at hupie.com R=dnslookup T=remote_smtp defer (0): SMTP error from remote mail server after initial connection: host iris3.directnic.com [74.117.222.13]: 421 4.3.2 iris3.directnic.com is already maintaning 2 connections from your address; use one of those
> 2012-03-21 01:17:30 1SAAB7-0005MI-My == mailings at hupie.com R=dnslookup T=remote_smtp defer (0): SMTP error from remote mail server after initial connection: host iris3.directnic.com [74.117.222.13]: 421 4.3.2 iris3.directnic.com is already maintaning 2 connections from your address; use one of those
> 2012-03-21 01:17:30 1SAAB7-0005MY-PX == mailings at hupie.com R=dnslookup T=remote_smtp defer (0): SMTP error from remote mail server after initial connection: host iris3.directnic.com [74.117.222.13]: 421 4.3.2 iris3.directnic.com is already maintaning 2 connections from your address; use one of those
> 2012-03-21 01:17:30 1SAAB7-0005Mm-R7 == mailings at hupie.com R=dnslookup T=remote_smtp defer (0): SMTP error from remote mail server after initial connection: host iris3.directnic.com [74.117.222.13]: 421 4.3.2 iris3.directnic.com is already maintaning 2 connections from your address; use one of those
> 2012-03-21 01:17:30 1SAAB5-0005LP-Ia =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
> 2012-03-21 01:17:30 1SAAB5-0005LD-CV =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
> 2012-03-21 01:17:32 1SAAB9-0005Ny-SW =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
> 2012-03-21 01:58:49 1SAAp3-0005SP-Tn =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
> 2012-03-21 01:58:49 1SAAB7-0005M7-LM =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]*
> 2012-03-21 01:58:50 1SAAB7-0005M0-Ju =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]*
> 2012-03-21 01:58:50 1SAAB5-0005LL-HI =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]*
> 2012-03-21 07:18:41 1SAFod-0005nZ-3G =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
> 2012-03-21 07:21:01 1SAFqu-0005oH-A5 =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
> 2012-03-21 07:21:38 1SAFrV-0005oo-D0 =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
> 2012-03-21 07:22:41 1SAFsW-0005pK-Gf =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
> 2012-03-21 07:23:02 1SAFsr-0005pp-Ij =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
> 2012-03-21 07:25:10 1SAFuv-0005qR-Oe =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
> 2012-03-21 07:29:04 1SAFyh-0005rE-2Y =>  mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
>
> Ideas?
>
> --
> larsh

Ah! Thanks!

That finally confirms my suspicions.
I will transfer my domain away from directnic.

But shouldn't exim retry the failed emails?
That seems like a bug.

-- 
Ferry Huberts

[PATCH] Some Documentation Changes

[larsh]

On Wed, Mar 21, 2012 at 08:19:18AM +0100, Ferry Huberts wrote:
> I only received patches 1,2,5,6 and 7. The other ones are missing in my 
> inbox.
> I've seen this behaviour before, Lars can you check your mailer?

A quick grep of the exim mainlog:

2012-03-21 01:17:29 1SAAB5-0005LL-HI == mailings at hupie.com R=dnslookup T=remote_smtp defer (111): Connection refused
2012-03-21 01:17:29 1SAAB7-0005M0-Ju == mailings at hupie.com R=dnslookup T=remote_smtp defer (111): Connection refused
2012-03-21 01:17:30 1SAAB7-0005M7-LM == mailings at hupie.com R=dnslookup T=remote_smtp defer (0): SMTP error from remote mail server after initial connection: host iris3.directnic.com [74.117.222.13]: 421 4.3.2 iris3.directnic.com is already maintaning 2 connections from your address; use one of those
2012-03-21 01:17:30 1SAAB7-0005MI-My == mailings at hupie.com R=dnslookup T=remote_smtp defer (0): SMTP error from remote mail server after initial connection: host iris3.directnic.com [74.117.222.13]: 421 4.3.2 iris3.directnic.com is already maintaning 2 connections from your address; use one of those
2012-03-21 01:17:30 1SAAB7-0005MY-PX == mailings at hupie.com R=dnslookup T=remote_smtp defer (0): SMTP error from remote mail server after initial connection: host iris3.directnic.com [74.117.222.13]: 421 4.3.2 iris3.directnic.com is already maintaning 2 connections from your address; use one of those
2012-03-21 01:17:30 1SAAB7-0005Mm-R7 == mailings at hupie.com R=dnslookup T=remote_smtp defer (0): SMTP error from remote mail server after initial connection: host iris3.directnic.com [74.117.222.13]: 421 4.3.2 iris3.directnic.com is already maintaning 2 connections from your address; use one of those
2012-03-21 01:17:30 1SAAB5-0005LP-Ia => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
2012-03-21 01:17:30 1SAAB5-0005LD-CV => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
2012-03-21 01:17:32 1SAAB9-0005Ny-SW => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
2012-03-21 01:58:49 1SAAp3-0005SP-Tn => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
2012-03-21 01:58:49 1SAAB7-0005M7-LM => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]*
2012-03-21 01:58:50 1SAAB7-0005M0-Ju => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]*
2012-03-21 01:58:50 1SAAB5-0005LL-HI => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]*
2012-03-21 07:18:41 1SAFod-0005nZ-3G => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
2012-03-21 07:21:01 1SAFqu-0005oH-A5 => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
2012-03-21 07:21:38 1SAFrV-0005oo-D0 => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
2012-03-21 07:22:41 1SAFsW-0005pK-Gf => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
2012-03-21 07:23:02 1SAFsr-0005pp-Ij => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
2012-03-21 07:25:10 1SAFuv-0005qR-Oe => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]
2012-03-21 07:29:04 1SAFyh-0005rE-2Y => mailings at hupie.com R=dnslookup T=remote_smtp H=iris3.directnic.com [74.117.222.13]

Ideas?

--
larsh

[PATCH 2/8] changed wording of deprecated options

[jamie.couture]

On Wed, Mar 21, 2012 at 3:15 AM, Ferry Huberts <mailings at hupie.com> wrote:

>
>
> On 21-03-12 02:07, Jamie Couture wrote:
>
>> Signed-off-by: Jamie Couture<jamie.couture at gmail.**com<jamie.couture at gmail.com>
>> >
>> ---
>>  cgitrc.5.txt |   23 +++++++++--------------
>>  1 file changed, 9 insertions(+), 14 deletions(-)
>>
>> diff --git a/cgitrc.5.txt b/cgitrc.5.txt
>> index 971d960..2329087 100644
>> --- a/cgitrc.5.txt
>> +++ b/cgitrc.5.txt
>> @@ -457,26 +457,21 @@ DEPRECATED OPTIONS
>>  ------------------
>>
>>  index-header::
>> -       The content of the file specified with this option will be
>> included
>> -       verbatim above the repository index. This setting is deprecated,
>> and
>> -       will not be supported by cgit-1.0 (use root-readme instead).
>> Default
>> -       value: none.
>> +       Use `root-readme` instead. Deprecated since _v1.0_. The content
>> of the
>> +       file specified with this option will be included verbatim above
>> the
>> +       repository index. Default value: none.
>>
>>
>
> I think you didn't read it well enough :-)
> The option is deprecated _now_, and _unsupported_ in 1.0
>
> No, I certainly didn't look in history to say at which version these
options have been deprecated. index-info is dead code and will never be
executed, whereas index-header, nocache and repo.group are still possible
to reach.

Sister patches in this series remove this respective code completely,
I figured the messaging could be changed to explicitly point that out,
but arguably there is no need. One could skip this patch.

I'll add that I didn't bother submitting patches to remove 'nocache' or
repo.group
since '--noacache' is useful for command line and debugging purposes, and
repo.group
is legacy and didn't want to break anyone's configuration.

Same for the other options, so no need to change the texts IMHO
>
>

>
>   index-info::
>> -       The content of the file specified with this option will be
>> included
>> -       verbatim below the heading on the repository index page. This
>> setting
>> -       is deprecated, and will not be supported by cgit-1.0 (use
>> root-desc
>> -       instead). Default value: none.
>> +       Use `root-desc` instead. Deprecated since _v1.0_. The content of
>> the file
>> +       specified with this option will be included verbatim below the
>> heading on
>> +       the repository index page. Default value: none.
>>
>>  nocache::
>> -       If set to the value "1" caching will be disabled. This settings is
>> -       deprecated, and will not be honored starting with cgit-1.0.
>> Default
>> -       value: "0".
>> +       Deprecated since _v1.0_. If set to the value "1" caching will be
>> +       disabled. Default value: "0".
>>
>>  repo.group::
>> -       Legacy alias for "section". This option is deprecated and will
>> not be
>> -       supported in cgit-1.0.
>> -
>> +       Deprecated since _v1.0_. Legacy alias for "section".
>>
>>
>>  REPOSITORY-SPECIFIC CGITRC FILE
>>
>
> --
> Ferry Huberts
>
>