show: implement "stack" view
People often want to know what they are working on *now*. As part of
this, they also commonly want to know how that work is related to other
changesets in the repo so they can perform common actions like rebase,
histedit, and merge.
`hg show work` made headway into this space. However, it is geared
towards a complete repo view as opposed to just the current line of
work. If you have a lot of in-flight work or the repo has many heads,
the output can be overwhelming. The closest thing Mercurial has to
"show me the current thing I'm working on" that doesn't require custom
revsets is `hg qseries`. And this requires MQ, which completely changes
workflows and repository behavior and has horrible performance on large
repos. But as sub-optimal as MQ is, it does some things right, such as
expose a model of the repo that is easy for people to reason about.
This simplicity is why I think a lot of people prefer to use MQ, despite
its shortcomings.
One common development workflow is to author a series of linear
changesets, using bookmarks, branches, anonymous heads, or even topics
(3rd party extension). I'll call this a "stack." You periodically
rewrite history in place (using `hg histedit`) and reparent the stack
against newer changesets (using `hg rebase`). This workflow can be
difficult because there is no obvious way to quickly see the current
"stack" nor its relation to other changesets. Figuring out arguments to
`hg rebase` can be difficult and may require highlighting and pasting
multiple changeset nodes to construct a command.
The goal of this commit is to make stack based workflows simpler
by exposing a view of the current stack and its relationship to
other releant changesets, notably the parent of the base changeset
in the stack and newer heads that the stack could be rebased or merged
into.
Introduced is the `hg show stack` view. Essentially, it finds all
mutable changesets from the working directory revision in both
directions, stopping at a merge or branch point. This limits the
revisions to a DAG linear range.
The stack is rendered as a concise list of changesets. Alongside the
stack is a visualization of the DAG, similar to `hg log -G`.
Newer public heads from the branch point of the stack are rendered
above the stack. The presence of these heads helps people understand
the DAG model and the relationship between the stack and changes made
since the branch point of that stack. If the "rebase" command is
available, a `hg rebase` command is printed for each head so a user
can perform a simple copy and paste to perform a rebase.
This view is alpha quality. There are tons of TODOs documented
inline. But I think it is good enough for a first iteration.
$ cat >> $HGRCPATH << EOF
> [extensions]
> show =
> EOF
No arguments shows available views
$ hg init empty
$ cd empty
$ hg show
available views:
bookmarks -- bookmarks and their associated changeset
stack -- current line of work
work -- changesets that aren't finished
abort: no view requested
(use "hg show VIEW" to choose a view)
[255]
`hg help show` prints available views
$ hg help show
hg show VIEW
show various repository information
A requested view of repository data is displayed.
If no view is requested, the list of available views is shown and the
command aborts.
Note:
There are no backwards compatibility guarantees for the output of this
command. Output may change in any future Mercurial release.
Consumers wanting stable command output should specify a template via
"-T/--template".
List of available views:
bookmarks bookmarks and their associated changeset
stack current line of work
work changesets that aren't finished
(use 'hg help -e show' to show help for the show extension)
options:
-T --template TEMPLATE display with template
(some details hidden, use --verbose to show complete help)
Unknown view prints error
$ hg show badview
abort: unknown view: badview
(run "hg show" to see available views)
[255]
HGPLAIN results in abort
$ HGPLAIN=1 hg show bookmarks
abort: must specify a template in plain mode
(invoke with -T/--template to control output format)
[255]
But not if a template is specified
$ HGPLAIN=1 hg show bookmarks -T '{bookmark}\n'
(no bookmarks set)
$ cd ..
bookmarks view with no bookmarks prints empty message
$ hg init books
$ cd books
$ touch f0
$ hg -q commit -A -m initial
$ hg show bookmarks
(no bookmarks set)
bookmarks view shows bookmarks in an aligned table
$ echo book1 > f0
$ hg commit -m 'commit for book1'
$ echo book2 > f0
$ hg commit -m 'commit for book2'
$ hg bookmark -r 1 book1
$ hg bookmark a-longer-bookmark
$ hg show bookmarks
* a-longer-bookmark 7b570
book1 b757f
A custom bookmarks template works
$ hg show bookmarks -T '{node} {bookmark} {active}\n'
7b5709ab64cbc34da9b4367b64afff47f2c4ee83 a-longer-bookmark True
b757f780b8ffd71267c6ccb32e0882d9d32a8cc0 book1 False
bookmarks JSON works
$ hg show bookmarks -T json
[
{
"active": true,
"bookmark": "a-longer-bookmark",
"longestbookmarklen": 17,
"node": "7b5709ab64cbc34da9b4367b64afff47f2c4ee83"
},
{
"active": false,
"bookmark": "book1",
"longestbookmarklen": 17,
"node": "b757f780b8ffd71267c6ccb32e0882d9d32a8cc0"
}
]
JSON works with no bookmarks
$ hg book -d a-longer-bookmark
$ hg book -d book1
$ hg show bookmarks -T json
[
]
commands.show.aliasprefix aliases values to `show <view>`
$ hg --config commands.show.aliasprefix=s sbookmarks
(no bookmarks set)
$ hg --config commands.show.aliasprefix=sh shwork
@ 7b570 commit for book2
o b757f commit for book1
o ba592 initial
$ hg --config commands.show.aliasprefix='s sh' swork
@ 7b570 commit for book2
o b757f commit for book1
o ba592 initial
$ hg --config commands.show.aliasprefix='s sh' shwork
@ 7b570 commit for book2
o b757f commit for book1
o ba592 initial
The aliases don't appear in `hg config`
$ hg --config commands.show.aliasprefix=s config alias
[1]
Doesn't overwrite existing alias
$ hg --config alias.swork='log -r .' --config commands.show.aliasprefix=s swork
changeset: 2:7b5709ab64cb
tag: tip
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: commit for book2
$ hg --config alias.swork='log -r .' --config commands.show.aliasprefix=s config alias
alias.swork=log -r .
$ cd ..