diff --git a/step-file/src/main/xml/specification.xml b/step-file/src/main/xml/specification.xml index f268c05..030f77f 100644 --- a/step-file/src/main/xml/specification.xml +++ b/step-file/src/main/xml/specification.xml @@ -148,13 +148,20 @@ steps is assumed; for background details, see Regular expressions that match a/a/b/file.txt are, for example, ^(\w+/){2,3}.+\.txt$, a/a/b/, or /file\.[^/]+$. - If any pattern matches the slash-augmented relative path, the entry is included in the output. - If a directory’s path matches the inclusion regex, the directory’s content will not automatically be included, too. - They need to match, the regular expression, too. So the filter regex ^dir/ will match the directory - content but ^dir/$ won’t, and as a consequence the directory’s content will not be included in the result. - If a relative path is matched by an include filter, - all its ancestor directories starting from the initial directory (but not their content if not included explicitly) - will be included, too. + If any pattern matches the + slash-augmented relative path, the entry is included in the output. Matching a directory + doesn’t automatically include the contents of the directory or its descendants; to be included, + each individual entry must match an include filter. + For example, the filter regex ^dir/ will match a + directory and its content, but ^dir/$ won’t. + + Although matching a directory doesn’t automatically include its + entries, matching an entry does automatically include + all of its ancestors (back to the initial directory). This assures that the hierarchy + of the XML elements matches the hierarchy of the filesystem. When ancestors are + included this way, none of their other entires are included unless they match + an include filter. + Sample Directory List Output for a Single File For a file a/a/b/file.txt below the initial directory @@ -300,6 +307,13 @@ steps is assumed; for background details, see the resulting document has a base-uri. Its value is identical to the top-level element’s xml:base attribute, that is, to the directory’s URI. + + +Errata, April 2024 +Editorial clarifications. Fixed a grammatical error in the description of +include filters. Improved the description of include filter processing. + +