Skip to content

Commit ba52e20

Browse files
Add docs for ignored_resources
Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
1 parent 0193da2 commit ba52e20

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

docs/source/general.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ it will copy and store next to the .ABOUT files.
8585
* - name
8686
- Component name
8787
- Mandatory
88+
* - ignored_resources
89+
- List of paths ignored from the ``about_resource``
90+
- Optional
8891
* - version
8992
- Component version
9093
- Optional

docs/source/specification.rst

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -218,11 +218,14 @@ in any case combination.
218218
Referencing the file or directory documented by an ABOUT file
219219
-------------------------------------------------------------
220220

221-
An ABOUT file documents one file or directory. The mandatory "about_resource"
222-
field reference the documented file or directory. The value of the "about_resource"
223-
field is the name or path of the referenced file or directory.
221+
An ABOUT file documents one file or directory. The mandatory ``about_resource``
222+
field reference the documented file or directory. The value of the ``about_resource``
223+
field is the name or path of the referenced file or directory. There is also a
224+
``ignored_resources`` field which can be used to ignore a set of subpaths inside the
225+
directory which is being documented in the ABOUT file.
224226

225-
A tool processing an ABOUT file must report an error if this field is missing.
227+
A tool processing an ABOUT file must report an error if the ``about_resource``
228+
field is missing.
226229

227230
By convention, an ABOUT file is often stored in the same directory side-by-side
228231
to the file or directory that it documents, but this is not mandatory.
@@ -240,6 +243,14 @@ In this example, the ABOUT file documents a whole sub-directory:
240243
241244
about_resource: linux-kernel-2.6.23
242245
246+
In this example, the ABOUT file documents a whole sub-directory, with some
247+
sub-paths under the directory ignored:
248+
249+
.. code-block:: none
250+
251+
about_resource: linux-kernel-2.6.23
252+
ignored_resources: linux-kernel-2.6.23/Documentation
253+
243254
In this example, the ABOUT file documents the current directory, using a "." period to reference it:
244255

245256
.. code-block:: none
@@ -258,6 +269,9 @@ mandatory field are missing.
258269
Optional Information fields
259270
---------------------------
260271

272+
- ignored_resources: A list of paths under the ``about_resource`` path, which are
273+
not documented in the ABOUT file, and the information in the ABOUT file does not
274+
apply to these subpaths.
261275
- version: Component or package version. A component or package usually has a version,
262276
such as a revision number or hash from a version control system (for a snapshot checked
263277
out from VCS such as Subversion or Git). If not available, the version should be the date

0 commit comments

Comments
 (0)