diff mbox

[2/3] manual: cvs: document that a date can be used instead of a tag

Message ID 1429376067-9228-3-git-send-email-fabio.porcedda@gmail.com
State Superseded
Headers show

Commit Message

Fabio Porcedda April 18, 2015, 4:54 p.m. UTC
Also instead of using the generic word "timestamp" use the word "tag".

Signed-off-by: Fabio Porcedda <fabio.porcedda@gmail.com>
---
 docs/manual/adding-packages-generic.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Yann E. MORIN April 19, 2015, 8:10 a.m. UTC | #1
Fabio, All,

On 2015-04-18 18:54 +0200, Fabio Porcedda spake thusly:
> Also instead of using the generic word "timestamp" use the word "tag".
> 
> Signed-off-by: Fabio Porcedda <fabio.porcedda@gmail.com>
> ---
>  docs/manual/adding-packages-generic.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt
> index 8cf6bb6..be754a2 100644
> --- a/docs/manual/adding-packages-generic.txt
> +++ b/docs/manual/adding-packages-generic.txt
> @@ -280,7 +280,7 @@ information is (assuming the package name is +libfoo+) :
>       Only anonymous pserver mode is supported.
>       +LIBFOO_SITE+ 'must' contain the source URL as well as the remote
>       repository directory. The module is the package name.
> -     +LIBFOO_VERSION+ is 'mandatory' and 'must' be a timestamp.
> +     +LIBFOO_VERSION+ is 'mandatory' and 'must' be a tag or a date.

I'd like we document the format of the date we recognise. Because, IIRC,
cvs accepts 'yesterday' as a date format, and that would be interpreted
as a tag with the current code.

So maybe, just state something like:

    ... or a date (YYYYMMDD:hhmmss)

Or whatever is a date format recognised.

Regards,
Yann E. MORIN.

>    ** +git+ for retrieving source code from a Git repository. Used by
>       default when +LIBFOO_SITE+ begins with +git://+. The downloaded
>       source code is cached as with the +svn+
> -- 
> 2.3.5
>
Fabio Porcedda April 19, 2015, 10:08 a.m. UTC | #2
On Sun, Apr 19, 2015 at 10:10 AM, Yann E. MORIN <yann.morin.1998@free.fr> wrote:
> Fabio, All,
>
> On 2015-04-18 18:54 +0200, Fabio Porcedda spake thusly:
>> Also instead of using the generic word "timestamp" use the word "tag".
>>
>> Signed-off-by: Fabio Porcedda <fabio.porcedda@gmail.com>
>> ---
>>  docs/manual/adding-packages-generic.txt | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt
>> index 8cf6bb6..be754a2 100644
>> --- a/docs/manual/adding-packages-generic.txt
>> +++ b/docs/manual/adding-packages-generic.txt
>> @@ -280,7 +280,7 @@ information is (assuming the package name is +libfoo+) :
>>       Only anonymous pserver mode is supported.
>>       +LIBFOO_SITE+ 'must' contain the source URL as well as the remote
>>       repository directory. The module is the package name.
>> -     +LIBFOO_VERSION+ is 'mandatory' and 'must' be a timestamp.
>> +     +LIBFOO_VERSION+ is 'mandatory' and 'must' be a tag or a date.
>
> I'd like we document the format of the date we recognise. Because, IIRC,
> cvs accepts 'yesterday' as a date format, and that would be interpreted
> as a tag with the current code.
>
> So maybe, just state something like:
>
>     ... or a date (YYYYMMDD:hhmmss)

What about this:
(<YYYY>-<MM>-<DD>[T<HH><MM>[<SS>]] e.g 2015-12-20 or 2015-12-20T1010)

> Or whatever is a date format recognised.
>

Thanks for reviewing.
Arnout Vandecappelle April 19, 2015, 3:45 p.m. UTC | #3
On 19/04/15 12:08, Fabio Porcedda wrote:
> On Sun, Apr 19, 2015 at 10:10 AM, Yann E. MORIN <yann.morin.1998@free.fr> wrote:
>> Fabio, All,
>>
>> On 2015-04-18 18:54 +0200, Fabio Porcedda spake thusly:
>>> Also instead of using the generic word "timestamp" use the word "tag".
>>>
>>> Signed-off-by: Fabio Porcedda <fabio.porcedda@gmail.com>
>>> ---
>>>  docs/manual/adding-packages-generic.txt | 2 +-
>>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt
>>> index 8cf6bb6..be754a2 100644
>>> --- a/docs/manual/adding-packages-generic.txt
>>> +++ b/docs/manual/adding-packages-generic.txt
>>> @@ -280,7 +280,7 @@ information is (assuming the package name is +libfoo+) :
>>>       Only anonymous pserver mode is supported.
>>>       +LIBFOO_SITE+ 'must' contain the source URL as well as the remote
>>>       repository directory. The module is the package name.
>>> -     +LIBFOO_VERSION+ is 'mandatory' and 'must' be a timestamp.
>>> +     +LIBFOO_VERSION+ is 'mandatory' and 'must' be a tag or a date.
>>
>> I'd like we document the format of the date we recognise. Because, IIRC,
>> cvs accepts 'yesterday' as a date format, and that would be interpreted
>> as a tag with the current code.
>>
>> So maybe, just state something like:
>>
>>     ... or a date (YYYYMMDD:hhmmss)
> 
> What about this:
> (<YYYY>-<MM>-<DD>[T<HH><MM>[<SS>]] e.g 2015-12-20 or 2015-12-20T1010)

 Can a timezone be added to that? Playing with dates and times without timezone
is dangerous.

 Regards,
 Arnout
Yann E. MORIN April 20, 2015, 5:32 p.m. UTC | #4
Fabio, All,

On 2015-04-19 12:08 +0200, Fabio Porcedda spake thusly:
> On Sun, Apr 19, 2015 at 10:10 AM, Yann E. MORIN <yann.morin.1998@free.fr> wrote:
> > On 2015-04-18 18:54 +0200, Fabio Porcedda spake thusly:
[--SNIP--]
> >> -     +LIBFOO_VERSION+ is 'mandatory' and 'must' be a timestamp.
> >> +     +LIBFOO_VERSION+ is 'mandatory' and 'must' be a tag or a date.
> >
> > I'd like we document the format of the date we recognise. Because, IIRC,
> > cvs accepts 'yesterday' as a date format, and that would be interpreted
> > as a tag with the current code.
> >
> > So maybe, just state something like:
> >
> >     ... or a date (YYYYMMDD:hhmmss)
> 
> What about this:
> (<YYYY>-<MM>-<DD>[T<HH><MM>[<SS>]] e.g 2015-12-20 or 2015-12-20T1010)

Well, this is exactly RFC3339;
    https://tools.ietf.org/html/rfc3339#section-5.8

So we may just state smehing along the lines of:

    ... or a date (formatted as defined in
    https://tools.ietf.org/html/rfc3339[RFC 3339]).

But I'd have to agree that it is not user-friendly, so we still want a
complete example, like so:

    ... or a date (formatted as defined in https://tools.ietf.org/html/rfc3339[RFC 3339],
    like <YYYY>-<MM>-<DD>[T<HH>:<MM>[:<SS>[.sss]]] e.g 2015-12-20 or 2015-12-20T10:10 or
    even 2015-12-20T16:42:12.467923; for complet ereference, see the
    http://sunsite.ualberta.ca/Documentation/Gnu/cvs-1.12.11/cvs.html#Date-input-formats[CVS
    manual]).

Regards,
Yann E. MORIN.
diff mbox

Patch

diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt
index 8cf6bb6..be754a2 100644
--- a/docs/manual/adding-packages-generic.txt
+++ b/docs/manual/adding-packages-generic.txt
@@ -280,7 +280,7 @@  information is (assuming the package name is +libfoo+) :
      Only anonymous pserver mode is supported.
      +LIBFOO_SITE+ 'must' contain the source URL as well as the remote
      repository directory. The module is the package name.
-     +LIBFOO_VERSION+ is 'mandatory' and 'must' be a timestamp.
+     +LIBFOO_VERSION+ is 'mandatory' and 'must' be a tag or a date.
   ** +git+ for retrieving source code from a Git repository. Used by
      default when +LIBFOO_SITE+ begins with +git://+. The downloaded
      source code is cached as with the +svn+