Re: [Gnu-arch-users] Re: "Newbie-ized help"

[Zenaan Harkness]

On Tue, 2004-09-28 at 13:52, Miles Bader wrote:
> Anand Kumria <address@hidden> writes:
> >>   2) Please show "add-id", not "add".
> >
> > Please don't, that wouldn't be 'newbie' friendly.
> 
> Bullshit.  "add-id" is much more clear as to what the command is doing.

$ bk help add
bk new(1)                   BitKeeper User's Manual                  bk
new(1)

NAME
       bk new - add a file to the repository

SYNOPSIS
       bk new [-bq] <file>
       bk sfiles -x | bk new -
...


$ bk help new
bk new(1)                   BitKeeper User's Manual                  bk new(1)

NAME
       bk new - add a file to the repository

SYNOPSIS
       bk new [-bq] <file>
       bk sfiles -x | bk new -

DESCRIPTION
       The  new  command  is  used when placing files under BitKeeper control.
       The first form checks in a single file, the second form checks  in  all
       files in the repository which are not under BitKeeper control (be care-
       ful, the second form will check in anything, such as a.out, *.o,  core,
       etc.).  The bk new command is an alias for bk delta -i.  For a complete
       list of options see bk help delta.

       When checking in multiple files in a directory, do:

           bk sfiles -x *.[ch] | bk new -

       When you want to check in files in the current directory and all subdi-
       rectories, do the following:

           bk sfiles -x | egrep '*.[ch]$' | bk new -

       After  the  files  are  checked  in, don't be surprised to see that the
       files are no longer in your directory. The process of checking in files
       removes the files from the directory and places them in the SCCS direc-
       tories.  Once in the SCCS directory, the file can be retrieved with the
       bk  get  or  bk  edit commands.  Most versions of the Unix make command
       know about SCCS and will automatically check  out  files  as  they  are
       needed.

OPTIONS
       -b     force binary encoding with no keyword expansion; recommended for
              all binaries and Postscript files, but will work on  text  files
              as well.
       -q     be quiet.

SEE ALSO
       bk help delta
       bk help edit
       bk help get
       bk help sfiles

CATEGORY
       File
       Common

BitMover, Inc                     2003/12/09                         bk new(1)


$ bk help rm
bk rm(1)                    BitKeeper User's Manual                   bk rm(1)

NAME
       bk rm - remove BitKeeper file[s]

SYNOPSIS
       bk rm [-f] <file1> [<file> ...]

DESCRIPTION
       To delete a file, do this:

           $ bk rm foo.c

       Removing   the   file  actually  moves  it  to  BitKeeper/deleted/.del-
       foo.c~293843edf341df.  All  future  operations  will  ignore  the  file
       unless  you  name it explicitly, but it will still exist in the reposi-
       tory and will still be propagated by bk pull and/or  bk  push.   Edited
       files can not be deleted, you must check them in first.

       If  you wish to obliterate all traces of a file, use the bk gone facil-
       ity.

       To resurrect the file, use bk unrm.

           bk unrm foo.c

NOTES
       bk rm will not remove directories, use bk rmdir for that.

       bk rm will refuse to remove BitKeeper metafiles without the  -f  option
       (use of which is not recommended).

SEE ALSO
       bk help gone
       bk help rmdir
       bk help unrm

CATEGORY
       File

BitMover, Inc                     2003/06/04                          bk rm(1)