Skip to content

Commit

Permalink
Added section on important design decisions.
Browse files Browse the repository at this point in the history
Signed-off-by: Ralph Lange <[email protected]>
  • Loading branch information
ralph-lange committed Mar 13, 2024
1 parent 040c7eb commit 007d8b2
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions rep-0149.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Copy link
@peci1

peci1 Mar 13, 2024

Contributor

spacse -> spaces

This comment has been minimized.

Copy link
@ralph-lange

ralph-lange Mar 14, 2024

Author Contributor

Thank you for spotting this typo. I fixed it in boschresearch@49c1b3a.

``license`` tags have to be used in this rare case.


References
==========

Expand Down

0 comments on commit 007d8b2

Please sign in to comment.