-
Notifications
You must be signed in to change notification settings - Fork 137
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added section on important design decisions.
Signed-off-by: Ralph Lange <[email protected]>
- Loading branch information
1 parent
040c7eb
commit 007d8b2
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1145,6 +1145,37 @@ contained schema file like this: | |
</font> | ||
|
||
|
||
Design Decisions | ||
================ | ||
|
||
This section documents important decisions taken in the design of the package | ||
manifest format and summarizes discussions on the corresponding pull requests | ||
and in the ROS 2 TSC: | ||
|
||
* Extensions to ``license`` tag (accepted by ROS 2 TSC on 15 June 2023): | ||
* New optional attribute ``type`` is introduced to specify whether the | ||
license name used in the tag follows the SPDX standard or is freeform. | ||
For the time being, to avoid huge number of errors from legacy packages, | ||
the default value is ``freeform`` and not ``spdx``. However, awareness | ||
for importance of using standardized license names shall be increased | ||
in the community. Furthermore, a corresponding linter warning shall be | ||
implemented. | ||
* For the ``source-files`` attribute two alternatives were discussed: | ||
(1) Single attribute following directly the specification of the | ||
``Files`` field in the `Machine-readable debian/copyright file specification V1.0 | ||
<https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/>`_. | ||
The filename patterns syntax specified in this standard is in parts | ||
rather unusual in the ROS context, in particular the use of space as | ||
separator. | ||
(2) Introduce own syntax for the specification of file sets using | ||
additional (nested) XML tags. | ||
To keep translation of the ``source-files`` attribute to the copyright | ||
file as simple and transparent as possible, the first alternative is | ||
chosen, with the restriction that multiple filename patterns separated | ||
by spacse are not allowed in the attribute value. Instead, multiple | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
ralph-lange
Author
Contributor
|
||
``license`` tags have to be used in this rare case. | ||
|
||
|
||
References | ||
========== | ||
|
||
|
spacse -> spaces