# HG changeset patch # User Christian Ebert # Date 1249485933 -7200 # Node ID 7e80fc29ba271229e03c6270a815adf0bc657ee6 # Parent d41074cb161bf42bcd63c93f7ef1c59ae6ec51c8 (0.9.2compat) update and rewrap documentation diff -r d41074cb161b -r 7e80fc29ba27 hgkw/keyword.py --- a/hgkw/keyword.py Wed Aug 05 17:18:32 2009 +0200 +++ b/hgkw/keyword.py Wed Aug 05 17:25:33 2009 +0200 @@ -36,15 +36,15 @@ '''expand keywords in tracked files -This extension expands RCS/CVS-like or self-customized $Keywords$ in tracked -text files selected by your configuration. +This extension expands RCS/CVS-like or self-customized $Keywords$ in +tracked text files selected by your configuration. -Keywords are only expanded in local repositories and not stored in the change -history. The mechanism can be regarded as a convenience for the current user -or for archive distribution. +Keywords are only expanded in local repositories and not stored in the +change history. The mechanism can be regarded as a convenience for the +current user or for archive distribution. -Configuration is done in the [keyword] and [keywordmaps] sections of hgrc -files. +Configuration is done in the [keyword] and [keywordmaps] sections of +hgrc files. Example: @@ -53,32 +53,34 @@ **.py = x* = ignore -NOTE: the more specific you are in your filename patterns the less you lose -speed in huge repositories. +NOTE: the more specific you are in your filename patterns the less you +lose speed in huge repositories. -For [keywordmaps] template mapping and expansion demonstration and control run -"hg kwdemo". +For [keywordmaps] template mapping and expansion demonstration and +control run "hg kwdemo". -An additional date template filter {date|utcdate} is provided. +An additional date template filter {date|utcdate} is provided. It +returns a date like "2006/09/18 15:13:13". -The default template mappings (view with "hg kwdemo -d") can be replaced with -customized keywords and templates. Again, run "hg kwdemo" to control the -results of your config changes. +The default template mappings (view with "hg kwdemo -d") can be +replaced with customized keywords and templates. Again, run "hg +kwdemo" to control the results of your config changes. -Before changing/disabling active keywords, run "hg kwshrink" to avoid the risk -of inadvertently storing expanded keywords in the change history. +Before changing/disabling active keywords, run "hg kwshrink" to avoid +the risk of inadvertently storing expanded keywords in the change +history. -To force expansion after enabling it, or a configuration change, run "hg -kwexpand". +To force expansion after enabling it, or a configuration change, run +"hg kwexpand". -Also, when committing with the record extension or using mq's qrecord, be -aware that keywords cannot be updated. Again, run "hg kwexpand" on the files -in question to update keyword expansions after all changes have been checked -in. +Also, when committing with the record extension or using mq's qrecord, +be aware that keywords cannot be updated. Again, run "hg kwexpand" on +the files in question to update keyword expansions after all changes +have been checked in. -Expansions spanning more than one line and incremental expansions, like CVS' -$Log$, are not supported. A keyword template map "Log = {desc}" expands to the -first line of the changeset description. +Expansions spanning more than one line and incremental expansions, +like CVS' $Log$, are not supported. A keyword template map "Log = +{desc}" expands to the first line of the changeset description. Caveat: With Mercurial versions prior to 4574925db5c0 "hg import" might cause rejects if the patch context contains an active keyword. In that