Mercurial > hg
changeset 31749:17d0dab7b2b6
revlog: clarify flagprocessor documentation
The words "text", "newtext", "bool" could be confusing. Use explicit "text"
or "rawtext" and document more about the "bool".
author | Jun Wu <quark@fb.com> |
---|---|
date | Thu, 30 Mar 2017 07:59:48 -0700 |
parents | 985de02b5b9d |
children | f319981c24c9 |
files | mercurial/revlog.py |
diffstat | 1 files changed, 10 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/revlog.py Thu Mar 30 20:48:57 2017 -0700 +++ b/mercurial/revlog.py Thu Mar 30 07:59:48 2017 -0700 @@ -88,11 +88,17 @@ - Only one flag processor can be registered on a specific flag. - flagprocessors must be 3-tuples of functions (read, write, raw) with the following signatures: - - (read) f(self, text) -> newtext, bool - - (write) f(self, text) -> newtext, bool - - (raw) f(self, text) -> bool + - (read) f(self, rawtext) -> text, bool + - (write) f(self, text) -> rawtext, bool + - (raw) f(self, rawtext) -> bool + "text" is presented to the user. "rawtext" is stored in revlog data, not + directly visible to the user. The boolean returned by these transforms is used to determine whether - 'newtext' can be used for hash integrity checking. + the returned text can be used for hash integrity checking. For example, + if "write" returns False, then "text" is used to generate hash. If + "write" returns True, that basically means "rawtext" returned by "write" + should be used to generate hash. Usually, "write" and "read" return + different booleans. And "raw" returns a same boolean as "write". Note: The 'raw' transform is used for changegroup generation and in some debug commands. In this case the transform only indicates whether the