summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJan Pokorný <jpokorny@redhat.com>2014-06-16 15:07:56 +0200
committerJan Pokorný <jpokorny@redhat.com>2014-06-16 15:07:56 +0200
commite7cb18db3d544fb8eb7581616deb49ddb55b6497 (patch)
treee467c45deff1e7cfc5ccf81c3a61a325221dba8f /doc
parent835ecc03681383e76b6338240c2ce06ae6ecbcf2 (diff)
downloadclufter-e7cb18db3d544fb8eb7581616deb49ddb55b6497.tar.gz
clufter-e7cb18db3d544fb8eb7581616deb49ddb55b6497.tar.xz
clufter-e7cb18db3d544fb8eb7581616deb49ddb55b6497.zip
doc/HACKING: extend a bit, spin off sections for primitives
Signed-off-by: Jan Pokorný <jpokorny@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/HACKING32
1 files changed, 30 insertions, 2 deletions
diff --git a/doc/HACKING b/doc/HACKING
index 4b12b0c..de382e0 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -42,12 +42,35 @@ relationships:
- 'composite' denotes multi-channel interchange format
(consisting of atomic ones)
+Command
+-------
+
+
+Filter
+------
+
+
+Format
+------
+
+When defining a purpose-specific one, you can still utilize the inheritance
+and basic format distillation routines (`file` -> `bytestring` or viceversa).
+Even more, these are implicitly tried (in a backtracking manner,
+general-to-specific) if you redefine the distillation method with
+`chained=True`.
+
Command context
---------------
-This is a declared set of keys that should always be present and are
-intended for public use:
+One can imagine this as a glue rolling the key-value pairs directly
+to the commands (unrestricted modification, as a point of control for
+a subsequent processing), in more limited sense to filters, and very
+restrictively (read-only and only a few items) to the formats.
+
+It is a declared or shared, agreement-based set of keys that should
+always are expected to be present in the particular context of use.
+Strictly reserved, intended for public use, are:
- system: lowercased system specifier (e.g., linux)
- system_extra: tuple of string values with details about the system
@@ -91,6 +114,11 @@ Notable points
CommandAlias-backed functions should return string already
promoted to such dash notation
+4. some limitations:
+
+ - one particular filter can only occur once in the command's filter chain
+
+
x. to ease the perception of embedded XSLT snippets in the Python files,
there is respective _vimrc_local.vim provided (in filters/cluster)
so either run the contained sequence manually, or install lh-vim [1]