Improve documentation

rec · rec · commit 9f81bd3d2ac4 · 2025-04-17T11:35:28.000Z
diff --git a/README.md b/README.md
@@ -12,9 +12,47 @@ has ghstack information in it, or using string search.
 None of this would be useful without a local cache: getting all the needed information
 from github takes one to two seconds per pull request the first time.
 
-## Examples
+## A quick tour
 
-### List all your pull requests
+    $ pullman
+    #131354: [dynamo] Fix constant propagation in builtins and UserClasses
+    #145150: [inductor] Simplify _inductor/utils.py slightly
+    #145636: Simplify functional composition in _aot_autograd/dispatch_and_compile_graph.py
+    #146845: Fix non-bitwise type annotations for Tensor operators (see #145838)
+    #148959: Move token linter code into tools/linter/adaptors/_linter/
+    #149958: [inductor] Add some typing to _inductor/ir.py
+    #149959: [inductor] Add more typing to _inductor/ir.py
+    #150767: [inductor] Clean typing in codegen/common.py and codecache.py
+
+    $ git log -1 --oneline $(pm ref slightly)
+    c2f0f86cff2 (upstream/gh/rec/124/orig) [inductor] Simplify _inductor/utils.py slightly
+
+    $ pullman url -o functional  # Also opens #145636 in the browser
+    https://github.com/pytorch/pytorch/pull/145636
+
+    $ pullman errors constant
+    Writing unit-test-failures.sh for https://github.com/pytorch/pytorch/pull/131354
+    Loading jobs for 12893911506, segment=pull...
+    run_id='12893911506', len(jobs)=86, len(failed)=44
+    Loading jobs for 12893912723, segment=inductor...
+    run_id='12893912723', len(jobs)=38, len(failed)=27
+
+    # Wrote an executable shell file with commands to run the failed unit tests,
+    # or at least the ones the program can figure out...
+
+    $ pullman checkout --fetch --rewrite -r token
+    # Throws away the pullman cache, then calls
+    #
+    #    git fetch upstream
+    #    ghstack checkout https://github.com/pytorch/pytorch/pull/148959
+    #    git rebase upstream/viable/strict
+    #    git submodule update --init --recursive
+
+## Commands
+
+You can use any prefix of any of these commands, like `pullman l` or `pullman ch`.
+
+### `pullman list`: list all your pull requests
 
     $ pullman
     $ pullman l
@@ -25,20 +63,23 @@ from github takes one to two seconds per pull request the first time.
     #144622: [inductor] Enable docstring_linter on _inductor
     ...
 
-### List requests matching a string
-
     $ pullman list Add tests
     $ pullman Add tests
+
     #144621: [inductor] Add tests for new docstring_linter features (fix #142496)
 
-### Print URLs of pull request, optionally open them in a browser
+### `pullman url|commit_url|hud_url|ref_url`: print a URL, optionally open in a browser
 
     $ pullman url  # Looks at ghstack information in HEAD
     https://github.com/pytorch/pytorch/pull/148358
 
     $ pullman url other-branch  # Looks at ghstack information in some other branch
     https://github.com/pytorch/pytorch/pull/148358
 
+    # Use :/ to force a string search
+    $ pullman url :/other-branch
+    ERROR: Can't find any commits matching ':/other-branch'
+
     $ pullman url linter  # searches for pull requests matching "linter"
     https://github.com/pytorch/pytorch/pull/144621
 
@@ -48,17 +89,23 @@ from github takes one to two seconds per pull request the first time.
     $ pullman hud_url
     https://hudtorch.org/pr/148358
 
-    # Choose from `url`, `commit_url`, `hud_url`, `ref_url`
+### `pullman checkout`: run `ghstack checkout` on a matching pull request
 
-### Print ghstack branch ref
+    $ pullman checkout
+    # Calls `ghstack checkout` on the pull request that matches HEAD
+
+    $ pullman ref :/linter
+    upstream/gh/rec/137/orig
+
+### `pullman ref`: print ghstack branch git ref
 
     $ pullman ref
     upstream/gh/rec/136/orig
 
-    $ pullman ref :/linter
+    $ pullman ref linter
     upstream/gh/rec/137/orig
 
-### Download errors from a pull request
+### `pullman errors`: download errors from a pull request
 
     $ pullman errors
     $ pull
diff --git a/pullman.py b/pullman.py
@@ -477,15 +477,15 @@ def parse(argv):
             p.add_argument("--time", "-t", default=0, type=int, help=help)
 
         elif name == "checkout":
-            help = "Also rebase against a given git ref"
-            p.add_argument("--rebase-against", "-R", type=str, default="", help=help)
-
             help = "Also rebase against upstream/main"
             p.add_argument("--rebase-main", "-m", action="store_true", help=help)
 
             help = "Also rebase against upstream/viable/strict"
             p.add_argument("--rebase-strict", "-r", action="store_true", help=help)
 
+            help = "Also rebase against a given git ref"
+            p.add_argument("--rebase-against", "-R", type=str, default="", help=help)
+
         else:
             help = "The github user name"
             p.add_argument("--user", "-u", default="", type=str, help=help)
