Mercurial > public > mercurial-scm > hg-stable

comparison mercurial/help.py @ 7806:6d0cf2a2acad

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
help: better explanations for some of the template filters In particular, provide some example data for some of the common filters. Thanks go to timeless again for pointing out where we were lacking.
author Dirkjan Ochtman <dirkjan@ochtman.nl>
date Sat, 28 Feb 2009 12:25:14 +0100
parents cf6ec23a1bb5
children 5b010dae99c3
comparison
equal deleted inserted replaced
7805:cf6ec23a1bb5 7806:6d0cf2a2acad
307 307
308 List of filters: 308 List of filters:
309 309
310 - addbreaks: Any text. Add an XHTML "<br />" tag before the end of 310 - addbreaks: Any text. Add an XHTML "<br />" tag before the end of
311 every line except the last. 311 every line except the last.
312 - age: Date. Returns a human-readable age for the given date. 312 - age: Date. Returns a human-readable date/time difference between
313 the given date/time and the current date/time.
313 - basename: Any text. Treats the text as a path, and returns the 314 - basename: Any text. Treats the text as a path, and returns the
314 basename. For example, "foo/bar/baz" becomes "baz". 315 last component of the path after splitting by the path
315 - date: Date. Returns a date in a Unix date command format, including 316 separator (ignoring trailing seprators). For example,
317 "foo/bar/baz" becomes "baz" and "foo/bar//" becomes "bar".
318 - date: Date. Returns a date in a Unix date format, including
316 the timezone: "Mon Sep 04 15:13:13 2006 0700". 319 the timezone: "Mon Sep 04 15:13:13 2006 0700".
317 - domain: Any text. Finds the first string that looks like an email 320 - domain: Any text. Finds the first string that looks like an email
318 address, and extracts just the domain component. 321 address, and extracts just the domain component.
322 Example: 'User <user@example.com>' becomes 'example.com'.
319 - email: Any text. Extracts the first string that looks like an email 323 - email: Any text. Extracts the first string that looks like an email
320 address. 324 address. Example: 'User <user@example.com>' becomes
325 'user@example.com'.
321 - escape: Any text. Replaces the special XML/XHTML characters "&", 326 - escape: Any text. Replaces the special XML/XHTML characters "&",
322 "<" and ">" with XML entities. 327 "<" and ">" with XML entities.
323 - fill68: Any text. Wraps the text to fit in 68 columns. 328 - fill68: Any text. Wraps the text to fit in 68 columns.
324 - fill76: Any text. Wraps the text to fit in 76 columns. 329 - fill76: Any text. Wraps the text to fit in 76 columns.
325 - firstline: Any text. Returns the first line of text. 330 - firstline: Any text. Returns the first line of text.
331 - person: Any text. Returns the text before an email address. 336 - person: Any text. Returns the text before an email address.
332 - rfc822date: Date. Returns a date using the same format used 337 - rfc822date: Date. Returns a date using the same format used
333 in email headers. 338 in email headers.
334 - short: Changeset hash. Returns the short form of a changeset hash, 339 - short: Changeset hash. Returns the short form of a changeset hash,
335 i.e. a 12-byte hexadecimal string. 340 i.e. a 12-byte hexadecimal string.
336 - shortdate: Date. Returns a date like "2006-09-04". 341 - shortdate: Date. Returns a date like "2006-09-18".
337 - strip: Any text. Strips all leading and trailing whitespace. 342 - strip: Any text. Strips all leading and trailing whitespace.
338 - tabindent: Any text. Returns the text, with every line except the 343 - tabindent: Any text. Returns the text, with every line except the
339 first starting with a tab character. 344 first starting with a tab character.
340 - urlescape: Any text. Escapes all "special" characters. For example, 345 - urlescape: Any text. Escapes all "special" characters. For example,
341 "foo bar" becomes "foo%20bar". 346 "foo bar" becomes "foo%20bar".