Re: Documentation license

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, 14 Dec 2017, Matthew Wilcox <willy@xxxxxxxxxxxxx> wrote:
> 1. How does one add an SPDX tag to an rst file?

Do we want the SPDX tags visible in the generated documentation or not?

If not, you have to put it in an rst comment:

.. SPDX-License-Identifier: GPL-2.0

If yes, I'd go for using bibliographic data field lists [1]. They can be
and are already used for authorship and copyright, for example
Documentation/driver-api/device-io.rst which is rendered like [2]. There
are some alternatives for the field names, though none of the
"registered field names" seem to apply. For example:

:License: SPDX-License-Identifier: GPL-2.0
:SPDX: SPDX-License-Identifier: GPL-2.0
:SPDX-License-Identifier: GPL-2.0


BR,
Jani.


[1] http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#field-lists
[2] https://www.kernel.org/doc/html/latest/driver-api/device-io.html


-- 
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux