1 % help

     2 keyword extension - expand keywords in tracked files

     3 

     4 This extension expands RCS/CVS-like or self-customized $Keywords$ in tracked

     5 text files selected by your configuration.

     6 

     7 Keywords are only expanded in local repositories and not stored in the change

     8 history. The mechanism can be regarded as a convenience for the current user

     9 or for archive distribution.

    10 

    11 Configuration is done in the [keyword] and [keywordmaps] sections of hgrc

    12 files.

    13 

    14 Example:

    15 

    16   [keyword]

    17   # expand keywords in every python file except those matching "x*"

    18   **.py =

    19   x*    = ignore

    20 

    21 NOTE: the more specific you are in your filename patterns the less you lose

    22 speed in huge repositories.

    23 

    24 For [keywordmaps] template mapping and expansion demonstration and control run

    25 "hg kwdemo".

    26 

    27 An additional date template filter {date|utcdate} is provided.

    28 

    29 The default template mappings (view with "hg kwdemo -d") can be replaced with

    30 customized keywords and templates. Again, run "hg kwdemo" to control the

    31 results of your config changes.

    32 

    33 Before changing/disabling active keywords, run "hg kwshrink" to avoid the risk

    34 of inadvertently storing expanded keywords in the change history.

    35 

    36 To force expansion after enabling it, or a configuration change, run "hg

    37 kwexpand".

    38 

    39 Also, when committing with the record extension or using mq's qrecord, be

    40 aware that keywords cannot be updated. Again, run "hg kwexpand" on the files

    41 in question to update keyword expansions after all changes have been checked

    42 in.

    43 

    44 Expansions spanning more than one line and incremental expansions, like CVS'

    45 $Log$, are not supported. A keyword template map "Log = {desc}" expands to the

    46 first line of the changeset description.

    47 

    48 list of commands:

    49 

    50  kwdemo     print [keywordmaps] configuration and an expansion example

    51  kwexpand   expand keywords in the working directory

    52  kwfiles    show files configured for keyword expansion

    53  kwshrink   revert expanded keywords in the working directory

    54 

    55 enabled extensions:

    56 

    57  keyword   expand keywords in tracked files

    58  mq        manage a stack of patches

    59  notify    hooks for sending email notifications at commit/push time

    60 

    61 use "hg -v help keyword" to show aliases and global options