Skip to content

Commit

Permalink
Further explain what is-directory-structure does
Browse files Browse the repository at this point in the history
The documentation was not clear on how directory tree "structure" nodes
differed from normal directory tree nodes.
  • Loading branch information
jakepetroules committed Apr 28, 2018
1 parent 0f39104 commit 79dbc76
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/buildsystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -350,9 +350,19 @@ The following attributes are currently supported:

* - is-directory-structure
- A boolean value, indicating whether the node should represent the
directory structure of a file path. Such nodes should be name as
directory structure of a file path. Such nodes should be named as
'<path>/' (which would normally be a directory node), and then this
attributed used to change the type.
attribute used to change the type.

Directory structure nodes are affected by change tracking differently
than normal directory nodes. A normal directory node computes its
signatures effectively as the sum of the signatures of all its contained
files, recursively. A directory *structure* node's signature, by
contrast, is effectively the sum of the filenames of its contained files,
not taking into account their attributes or contents (except for the
attributes of the directory itself). Thus, this tracks when the
"structure" of the directory changes (for example, files are added or
removed), but not every modification to the files under the directory.

* - is-virtual
- A boolean value, indicating whether or not the node is "virtual". By
Expand Down

0 comments on commit 79dbc76

Please sign in to comment.