show: new extension for displaying various repository data Currently, Mercurial has a number of commands to show information. And, there are features coming down the pipe that will introduce more commands for showing information. Currently, when introducing a new class of data or a view that we wish to expose to the user, the strategy is to introduce a new command or overload an existing command, sometimes both. For example, there is a desire to formalize the wip/smartlog/underway/mine functionality that many have devised. There is also a desire to introduce a "topics" concept. Others would like views of "the current stack." In the current model, we'd need a new command for wip/smartlog/etc (that behaves a lot like a pre-defined alias of `hg log`). For topics, we'd likely overload `hg topic[s]` to both display and manipulate topics. Adding new commands for every pre-defined query doesn't scale well and pollutes `hg help`. Overloading commands to perform read-only and write operations is arguably an UX anti-pattern: while having all functionality for a given concept in one command is nice, having a single command doing multiple discrete operations is not. Furthermore, a user may be surprised that a command they thought was read-only actually changes something. We discussed this at the Mercurial 4.0 Sprint in Paris and decided that having a single command where we could hang pre-defined views of various data would be a good idea. Having such a command would: * Help prevent an explosion of new query-related commands * Create a clear separation between read and write operations (mitigates footguns) * Avoids overloading the meaning of commands that manipulate data (bookmark, tag, branch, etc) (while we can't take away the existing behavior for BC reasons, we now won't introduce this behavior on new commands) * Allows users to discover informational views more easily by aggregating them in a single location * Lowers the barrier to creating the new views (since the barrier to creating a top-level command is relatively high) So, this commit introduces the `hg show` command via the "show" extension. This command accepts a positional argument of the "view" to show. New views can be registered with a decorator. To prove it works, we implement the "bookmarks" view, which shows a table of bookmarks and their associated nodes. We introduce a new style to hold everything used by `hg show`. For our initial bookmarks view, the output varies from `hg bookmarks`: * Padding is performed in the template itself as opposed to Python * Revision integers are not shown * shortest() is used to display a 5 character node by default (as opposed to static 12 characters) I chose to implement the "bookmarks" view first because it is simple and shouldn't invite too much bikeshedding that detracts from the evaluation of `hg show` itself. But there is an important point to consider: we now have 2 ways to show a list of bookmarks. I'm not a fan of introducing multiple ways to do very similar things. So it might be worth discussing how we wish to tackle this issue for bookmarks, tags, branches, MQ series, etc. I also made the choice of explicitly declaring the default show template not part of the standard BC guarantees. History has shown that we make mistakes and poor choices with output formatting but can't fix these mistakes later because random tools are parsing output and we don't want to break these tools. Optimizing for human consumption is one of my goals for `hg show`. So, by not covering the formatting as part of BC, the barrier to future change is much lower and humans benefit. There are some improvements that can be made to formatting. For example, we don't yet use label() in the templates. We obviously want this for color. But I'm not sure if we should reuse the existing log.* labels or invent new ones. I figure we can punt that to a follow-up. At the aforementioned Sprint, we discussed and discarded various alternatives to `hg show`. We considered making `hg log <view>` perform this behavior. The main reason we can't do this is because a positional argument to `hg log` can be a file path and if there is a conflict between a path name and a view name, behavior is ambiguous. We could have introduced `hg log --view` or similar, but we felt that required too much typing (we don't want to require a command flag to show a view) and wasn't very discoverable. Furthermore, `hg log` is optimized for showing changelog data and there are things that `hg display` could display that aren't changelog centric. There were concerns about using "show" as the command name. Some users already have a "show" alias that is similar to `hg export`. There were also concerns that Git users adapted to `git show` would be confused by `hg show`'s different behavior. The main difference here is `git show` prints an `hg export` like view of the current commit by default and `hg show` requires an argument. `git show` can also display any Git object. `git show` does not support displaying more complex views: just single objects. If we implemented `hg show <hash>` or `hg show <identifier>`, `hg show` would be a superset of `git show`. Although, I'm hesitant to do that at this time because I view `hg show` as a higher-level querying command and there are namespace collisions between valid identifiers and registered views. There is also a prefix collision with `hg showconfig`, which is an alias of `hg config`. We also considered `hg view`, but that is already used by the "hgk" extension. `hg display` was also proposed at one point. It has a prefix collision with `hg diff`. General consensus was "show" or "view" are the best verbs. And since "view" was taken, "show" was chosen. There are a number of inline TODOs in this patch. Some of these represent decisions yet to be made. Others represent features requiring non-trivial complexity. Rather than bloat the patch or invite additional bikeshedding, I figured I'd document future enhancements via TODO so we can get a minimal implmentation landed. Something is better than nothing.

     1

#!/bin/sh

     2

     3

#

     4

# tcsh_completion_build.sh - script to generate tcsh completion

     5

#

     6

#

     7

# Copyright (C) 2005 TK Soh.

     8

#

     9

# This is free software; you can redistribute it and/or modify it under

    10

# the terms of the GNU General Public License as published by the Free

    11

# Software Foundation; either version 2 of the License, or (at your

    12

# option) any later version.

    13

#

    14

#

    15

# Description

    16

# -----------

    17

# This script generates a tcsh source file to support completion

    18

# of Mercurial commands and options.

    19

#

    20

# Instruction:

    21

# -----------

    22

# Run this script to generate the tcsh source file, and source

    23

# the file to add command completion support for Mercurial.

    24

#

    25

#    tcsh% tcsh_completion.sh FILE

    26

#    tcsh% source FILE

    27

#

    28

# If FILE is not specified, tcsh_completion will be generated.

    29

#

    30

# Bugs:

    31

# ----

    32

# 1. command specific options are not supported

    33

# 2. hg commands must be specified immediately after 'hg'.

    34

#

    35

    36

tcsh_file=${1-tcsh_completion}

    37

    38

hg_commands=`hg --debug help | \

    39

        sed -e '1,/^list of commands:/d' \

    40

            -e '/^enabled extensions:/,$d' \

    41

            -e '/^additional help topics:/,$d' \

    42

            -e '/^ [^ ]/!d; s/[,:]//g;' | \

    43

        xargs -n5 | \

    44

        sed -e '$!s/$/ \\\\/g; 2,$s/^ */    /g'`

    45

    46

hg_global_options=`hg -v help | \

    47

        sed -e '1,/global/d;/^ *-/!d; s/ [^- ].*//' | \

    48

        sed -e 's/ *$//; $!s/$/ \\\\/g; 2,$s/^ */    /g'`

    49

    50

hg_version=`hg version | sed -e '1q'`

    51

    52

script_name=`basename $0`

    53

    54

cat > $tcsh_file <<END

    55

#

    56

# tcsh completion for Mercurial

    57

#

    58

# This file has been auto-generated by $script_name for

    59

# $hg_version

    60

#

    61

# Copyright (C) 2005 TK Soh.

    62

#

    63

# This is free software; you can redistribute it and/or modify it under

    64

# the terms of the GNU General Public License as published by the Free

    65

# Software Foundation; either version 2 of the License, or (at your

    66

# option) any later version.

    67

#

    68

    69

complete hg \\

    70

  'n/--cwd/d/' 'n/-R/d/' 'n/--repository/d/' \\

    71

  'C/-/($hg_global_options)/' \\

    72

  'p/1/($hg_commands)/'

    73

    74

END