From: Eric S. Raymond Date: Sat, 15 Nov 2014 21:30:46 +0000 (-0500) Subject: Documentation for checkout and cat. X-Git-Tag: 0.9~19 X-Git-Url: http://thyrsus.com/gitweb/?a=commitdiff_plain;h=bb1faa822028736e6b86da0c67af05d86c311631;p=src.git Documentation for checkout and cat. --- diff --git a/NEWS b/NEWS index bca0ecf..d6021ef 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,8 @@ src project news +Repository head: + Branch deletion is imple,ented and tested. + SRC is now feature-complete as planned. Not all documentation is in place. 0.8: 2014-11-14 A branch label names the tip revision of its branch. diff --git a/src b/src index 11ff43c..767ee8f 100755 --- a/src +++ b/src @@ -265,6 +265,8 @@ revisions -- How to specify ranges of commits to operate on. commands -- a summary of the commands. commit -- the commit comand: how to commit changes to a file. amend -- the amend command: editing stored change comments. +checkout -- the checkout command: retrieving historical versions of files +cat -- the cat command: printing revisions to standard output status -- the status command: more details and unusual status codes ignores -- .srcignore files and their uses. """, @@ -507,7 +509,34 @@ The only difference is that existing change comment is appended to any text you specify with switches as the initial conent ppassed to your editor. """, - "ignores" : """ + "checkout":""" +src checkout ['revision'] ['file'...] + +Refresh the working copies of the file(s) from their history files. +'co' is a synonym for checkout. + +Takes a single revision number, tag, or branch name. The default if +you give none is the tip revision of the current branch. + +This command is how you discard the contents of a modified workfile. + +You can also use it to revert the workfile to match a previous +stored revision. Doing do may, as a side effect, change yoir current +branch. +""", + "cat" : """ +src cat ['revision'] ['file'...] + +Send the specified revision of each file to standard output. This is +not normally very useful with more than one file argument, but SRC +does not prevent that. + +Takes a single revision number, tag, or branch name. The default if +you give none is the tip revision of the current branch. + +This command is mainly intended for use in scripts. +""", + "ignores" : """ You can have a file named .srcignore containing the names of files that SRC should ignore, or more commonly patterns describing files to ignore. @@ -542,7 +571,7 @@ So, for example, [0123456789] would match any decimal digit. [!] brackets a negated character class; [!0123456789] would match any character not a decimal digit. -""" +""", } def help_method(*args):