[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
>
>