Bug 37453

Summary: more suitable command-line in articles/releng/article.sgml
Product: Documentation Reporter: Hideyuki KURASHINA <rushani>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Hideyuki KURASHINA 2002-04-25 15:10:01 UTC
'cvs up' seems to work as well as 'cvs update', but cvs(1) doesn't describe it.
I think 'cvs update' is more suitable than 'cvs up' as an article.

How-To-Repeat: In articles/releng/article.sgml, look '2.2.1 Creating the Release Branch' and
find following command-line;

    /usr/src# cvs up -rRELENG_4 -P -d
Comment 1 hiten pandya 2002-04-25 17:53:28 UTC
Hello,

>Number:         37453
>Category:       docs
>Synopsis:       more suitable command-line in articles/releng/article.sgml

>Description:
> 'cvs up' seems to work as well as 'cvs update', but cvs(1) doesn't
> describe it. I think 'cvs update' is more suitable than 'cvs up' as an 
> article.

If cvs(1) doesn't describe 'cvs up' properly, than I think it is the man page
which needs the fix and not the article, afaik.  All we need to do francly,
is
to add the following line to the cvs(1) man page which explains the 'update'
command:

%%
Synonyms: up
%%

P.S: IMHO

Regards,

  -- Hiten Pandya

__________________________________________________
Do You Yahoo!?
Yahoo! Games - play chess, backgammon, pool and more
http://games.yahoo.com/
Comment 2 Peter Pentchev 2002-04-25 18:43:41 UTC
On Thu, Apr 25, 2002 at 09:53:28AM -0700, Hiten Pandya wrote:
> Hello,
> 
> >Number:         37453
> >Category:       docs
> >Synopsis:       more suitable command-line in articles/releng/article.sgml
> 
> >Description:
> > 'cvs up' seems to work as well as 'cvs update', but cvs(1) doesn't
> > describe it. I think 'cvs update' is more suitable than 'cvs up' as an 
> > article.
> 
> If cvs(1) doesn't describe 'cvs up' properly, than I think it is the man page
> which needs the fix and not the article, afaik.  All we need to do francly,
> is
> to add the following line to the cvs(1) man page which explains the 'update'
> command:
> 
> %%
> Synonyms: up
> %%
> 
> P.S: IMHO


While cvs(1) really does accept 'up' as a synonym of 'update',
'up' is not documented either in the manual page, or in the info pages
(the Hederqvist manual), or in the cvs --help-commands output, I still
think that it would be a better idea to use the conventional 'update'.
After all, 'update' is the action you want CVS to perform, right?
'up' is not an action; 'up' is a direction; do you really want your
sources to go 'up' - like, 'up in smoke', 'up in flames', 'up into
the great blue yonder'? :)

This is MHO, too :)

G'luck,
Peter

-- 
Peter Pentchev	roam@ringlet.net	roam@FreeBSD.org
PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
This inert sentence is my body, but my soul is alive, dancing in the sparks of your brain.
Comment 3 hiten pandya 2002-04-25 19:05:52 UTC
--- Peter Pentchev <roam@ringlet.net> wrote:
> From: Peter Pentchev <roam@ringlet.net>
> To: hiten@uk.FreeBSD.org

>  While cvs(1) really does accept 'up' as a synonym of 'update',
>  'up' is not documented either in the manual page, or in the info pages
>  (the Hederqvist manual), or in the cvs --help-commands output, I still
>  think that it would be a better idea to use the conventional 'update'.
>  After all, 'update' is the action you want CVS to perform, right?
>  'up' is not an action; 'up' is a direction; do you really want your
>  sources to go 'up' - like, 'up in smoke', 'up in flames', 'up into
>  the great blue yonder'? :)
>  
>  This is MHO, too :)

Hehe, I understand.   What we can also do is, to change the instruction in 
the releng article to 'cvs update', and also add...

%%
Synonyms: up
%%

... to the cvs(1) manual page, and the CVS info manual.  What does everyone
think of this?

Regards.

  -- Hiten

__________________________________________________
Do You Yahoo!?
Yahoo! Games - play chess, backgammon, pool and more
http://games.yahoo.com/
Comment 4 brooks 2002-04-25 19:11:28 UTC
On Thu, Apr 25, 2002 at 11:05:52AM -0700, Hiten Pandya wrote:
> Hehe, I understand.   What we can also do is, to change the instruction in 
> the releng article to 'cvs update', and also add...
> 
> %%
> Synonyms: up
> %%
> 
> ... to the cvs(1) manual page, and the CVS info manual.  What does everyone
> think of this?


That we're not allowed to touch contributed source without a good reason
(and this DEFINATLY doesn't qualify) so you need to take this up with
the cvs developers and just fix the article.

-- Brooks

-- 
Any statement of the form "X is the one, true Y" is FALSE.
PGP fingerprint 655D 519C 26A7 82E7 2529  9BF0 5D8E 8BE9 F238 1AD4
Comment 5 Bruce A. Mah freebsd_committer freebsd_triage 2002-04-25 20:37:27 UTC
State Changed
From-To: open->closed

Committed...thanks!
Comment 6 Giorgos Keramidas freebsd_committer freebsd_triage 2002-04-26 01:16:12 UTC
On 2002-04-25 10:00, Hiten Pandya wrote:
> If cvs(1) doesn't describe 'cvs up' properly, than I think it is the
> man page which needs the fix and not the article, afaik.  All we
> need to do francly, is to add the following line to the cvs(1) man
> page which explains the 'update' command:
>
> %%
> Synonyms: up
> %%

This is already documented in `cvs --help' output.  The help of cvs
points to `cvs --help-synonyms' and that command prints all the
synonyms that CVS recognizes.  In any case, I think this is not a
problem with the documentation of FreeBSD (like the releng article),
but if for some reason someone thinks this is important we should
contact the developers who gave us CVS and ask politely that they
update their documentation to mention command synonyms.

Giorgos