Documentation/remote-helpers: Fix typos and improve language
[gitweb.git] / Documentation / cmd-list.perl
index 2143995ecef4c6175b6e28b180f433581913aa83..04f99778d81def42e9e129b2f5b2b0551a0c760f 100755 (executable)
@@ -3,7 +3,8 @@
 use File::Compare qw(compare);
 
 sub format_one {
-       my ($out, $name) = @_;
+       my ($out, $nameattr) = @_;
+       my ($name, $attr) = @$nameattr;
        my ($state, $description);
        $state = 0;
        open I, '<', "$name.txt" or die "No such file $name.txt";
@@ -26,8 +27,11 @@ sub format_one {
                die "No description found in $name.txt";
        }
        if (my ($verify_name, $text) = ($description =~ /^($name) - (.*)/)) {
-               print $out "gitlink:$name\[1\]::\n";
-               print $out "\t$text.\n\n";
+               print $out "linkgit:$name\[1\]::\n\t";
+               if ($attr =~ / deprecated /) {
+                       print $out "(deprecated) ";
+               }
+               print $out "$text.\n\n";
        }
        else {
                die "Description does not match $name: $description";
@@ -35,12 +39,13 @@ sub format_one {
 }
 
 my %cmds = ();
-while (<DATA>) {
+for (sort <>) {
        next if /^#/;
 
        chomp;
-       my ($name, $cat) = /^(\S+)\s+(.*)$/;
-       push @{$cmds{$cat}}, $name;
+       my ($name, $cat, $attr) = /^(\S+)\s+(.*?)(?:\s+(.*))?$/;
+       $attr = '' unless defined $attr;
+       push @{$cmds{$cat}}, [$name, " $attr "];
 }
 
 for my $cat (qw(ancillaryinterrogators
@@ -67,136 +72,3 @@ sub format_one {
                rename "$out+", "$out";
        }
 }
-
-__DATA__
-git-add                                 mainporcelain
-git-am                                  mainporcelain
-git-annotate                            ancillaryinterrogators
-git-apply                               plumbingmanipulators
-git-archimport                          foreignscminterface
-git-archive                             mainporcelain
-git-bisect                              mainporcelain
-git-blame                               ancillaryinterrogators
-git-branch                              mainporcelain
-git-bundle                              mainporcelain
-git-cat-file                            plumbinginterrogators
-git-checkout-index                      plumbingmanipulators
-git-checkout                            mainporcelain
-git-check-attr                          purehelpers
-git-check-ref-format                    purehelpers
-git-cherry                              ancillaryinterrogators
-git-cherry-pick                         mainporcelain
-git-citool                              mainporcelain
-git-clean                               mainporcelain
-git-clone                               mainporcelain
-git-commit                              mainporcelain
-git-commit-tree                         plumbingmanipulators
-git-convert-objects                     ancillarymanipulators
-git-count-objects                       ancillaryinterrogators
-git-cvsexportcommit                     foreignscminterface
-git-cvsimport                           foreignscminterface
-git-cvsserver                           foreignscminterface
-git-daemon                              synchingrepositories
-git-describe                            mainporcelain
-git-diff-files                          plumbinginterrogators
-git-diff-index                          plumbinginterrogators
-git-diff                                mainporcelain
-git-diff-tree                           plumbinginterrogators
-git-fast-import                                ancillarymanipulators
-git-fetch                               mainporcelain
-git-fetch-pack                          synchingrepositories
-git-filter-branch                       ancillarymanipulators
-git-fmt-merge-msg                       purehelpers
-git-for-each-ref                        plumbinginterrogators
-git-format-patch                        mainporcelain
-git-fsck                               ancillaryinterrogators
-git-gc                                  mainporcelain
-git-get-tar-commit-id                   ancillaryinterrogators
-git-grep                                mainporcelain
-git-gui                                 mainporcelain
-git-hash-object                         plumbingmanipulators
-git-http-fetch                          synchelpers
-git-http-push                           synchelpers
-git-imap-send                           foreignscminterface
-git-index-pack                          plumbingmanipulators
-git-init                                mainporcelain
-git-instaweb                            ancillaryinterrogators
-gitk                                    mainporcelain
-git-local-fetch                         synchingrepositories
-git-log                                 mainporcelain
-git-lost-found                          ancillarymanipulators
-git-ls-files                            plumbinginterrogators
-git-ls-remote                           plumbinginterrogators
-git-ls-tree                             plumbinginterrogators
-git-mailinfo                            purehelpers
-git-mailsplit                           purehelpers
-git-merge-base                          plumbinginterrogators
-git-merge-file                          plumbingmanipulators
-git-merge-index                         plumbingmanipulators
-git-merge                               mainporcelain
-git-merge-one-file                      purehelpers
-git-merge-tree                          ancillaryinterrogators
-git-mergetool                           ancillarymanipulators
-git-mktag                               plumbingmanipulators
-git-mktree                              plumbingmanipulators
-git-mv                                  mainporcelain
-git-name-rev                            plumbinginterrogators
-git-pack-objects                        plumbingmanipulators
-git-pack-redundant                      plumbinginterrogators
-git-pack-refs                           ancillarymanipulators
-git-parse-remote                        synchelpers
-git-patch-id                            purehelpers
-git-peek-remote                         purehelpers
-git-prune                               ancillarymanipulators
-git-prune-packed                        plumbingmanipulators
-git-pull                                mainporcelain
-git-push                                mainporcelain
-git-quiltimport                         foreignscminterface
-git-read-tree                           plumbingmanipulators
-git-rebase                              mainporcelain
-git-receive-pack                        synchelpers
-git-reflog                              ancillarymanipulators
-git-relink                              ancillarymanipulators
-git-repack                              ancillarymanipulators
-git-config                              ancillarymanipulators
-git-remote                              ancillarymanipulators
-git-request-pull                        foreignscminterface
-git-rerere                              ancillaryinterrogators
-git-reset                               mainporcelain
-git-revert                              mainporcelain
-git-rev-list                            plumbinginterrogators
-git-rev-parse                           ancillaryinterrogators
-git-rm                                  mainporcelain
-git-runstatus                           ancillaryinterrogators
-git-send-email                          foreignscminterface
-git-send-pack                           synchingrepositories
-git-shell                               synchelpers
-git-shortlog                            mainporcelain
-git-show                                mainporcelain
-git-show-branch                         ancillaryinterrogators
-git-show-index                          plumbinginterrogators
-git-show-ref                            plumbinginterrogators
-git-sh-setup                            purehelpers
-git-ssh-fetch                           synchingrepositories
-git-ssh-upload                          synchingrepositories
-git-stash                               mainporcelain
-git-status                              mainporcelain
-git-stripspace                          purehelpers
-git-submodule                           mainporcelain
-git-svn                                 foreignscminterface
-git-svnimport                           foreignscminterface
-git-symbolic-ref                        plumbingmanipulators
-git-tag                                 mainporcelain
-git-tar-tree                            plumbinginterrogators
-git-unpack-file                         plumbinginterrogators
-git-unpack-objects                      plumbingmanipulators
-git-update-index                        plumbingmanipulators
-git-update-ref                          plumbingmanipulators
-git-update-server-info                  synchingrepositories
-git-upload-archive                      synchelpers
-git-upload-pack                         synchelpers
-git-var                                 plumbinginterrogators
-git-verify-pack                         plumbinginterrogators
-git-verify-tag                          ancillaryinterrogators
-git-whatchanged                         ancillaryinterrogators
-git-write-tree                          plumbingmanipulators