Please include a license file in the sources

[Ankur Sinha]

Hello!

Similar to return42/fspath#1, could we please have a license file added here too?

Thanks very much,

[Markus Heiser]

Sure, I will have a look / BTW the way I will do some clean-up

[Ben Beasley]

While GPL is not one of the licenses that requires the license text to be included, a license file would still be helpful.

Beyond this, the GPL is normally applied via a license notice, which GNU recommends putting in the header of each source file. Even if the notice were only in the README, it would be good to include it, and the notice would help clarify whether the intended license is GPL-2.0-only or GPL-2.0-or-later.

You might also consider upgrading the deprecated SPDX identifier GPL-2.0 in the file headers to—I assume—GPL-2.0-only.

Thanks for having a look at this!

[Markus Heiser]

In 95b4dea I switched lic to AGPLv3+, added LIC file, fixed the SPDX tags (to AGPL-3.0-or-later) and released tag 20230321 on pypi --> https://pypi.org/project/linuxdoc/20230321/

@sanjayankur31 I hope I have thought of everything, if I have forgotten something, please let me know. Otherwise close the ticket / Thank you! 👍

[Ankur Sinha]

That looks great! Thanks for the quick update @return42 .

I'm also generating man pages for the different kernel-* scripts using help2man during our build. I can submit these as a PR if you'd like to include these here too (otherwise we just continue to include them in the Fedora package, which is fine too).

Here's the command in the current spec:

https://pagure.io/python-linuxdoc/blob/main/f/python-linuxdoc.spec#_52

[Markus Heiser]

OK, thanks for your feedback / I'm going to close this issue.

---

About man pages: IMO we should add man pages for the entry points (commands) here in the project.

linuxdoc/linuxdoc/__pkginfo__.py

Lines 115 to 123 in fd2f8ef

 def get_entry_points(): 
     """get entry points of the python package""" 
     return { 
         'console_scripts': [ 
             'kernel-doc = linuxdoc.kernel_doc:main', 
             'kernel-autodoc = linuxdoc.autodoc:main', 
             'kernel-lintdoc = linuxdoc.lint:main', 
             'kernel-grepdoc = linuxdoc.grep_doc:main', 
         ] 

Would you like to open a new issue (or PR if you have) / thanks!