Skip to content

Check that everything in a dir is documented by ABOUT files #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pombredanne opened this issue Jul 3, 2013 · 6 comments
Closed

Check that everything in a dir is documented by ABOUT files #10

pombredanne opened this issue Jul 3, 2013 · 6 comments

Comments

@pombredanne
Copy link
Member

We should have a feature such that given a directory, it will parse ABOUT files, and ensure that all files in the directory are directly or indirectly (ie from a parent directory) documented or referenced in an ABOUT file

@jdaguil
Copy link
Contributor

jdaguil commented Jul 4, 2013

@pombredanne can you explain this a little more..?

@pombredanne
Copy link
Member Author

@jdaguil I often store all my third party code in one dir. I would like to point to the tool that dir and ensure that all files in this dir are either ABOUT files or files or dir documented by an ABOUT file, ie checking that all the origin of all files and dir in a dir are properly documented.
This will help me find orphaned files (such as an old notice no longer used) and undocumented files for which I should add an ABOUT file

@chinyeungli
Copy link
Contributor

Similar issue in #24

@chinyeungli
Copy link
Contributor

@pombredanne
Let see if I have a component which the whole codebase is under apache-2.0.
Then, I will have a ABOUT file placed in the root of the component.

However, there are cases that the component contains build scripts/config files which are under gpl-2.0 which should not consider as the license for the component.
Should these script/config files also be included in this ABOUT file?

@grv87
Copy link

grv87 commented Jun 5, 2019

However, there are cases that the component contains build scripts/config files which are under gpl-2.0 which should not consider as the license for the component.

If ABOUT file says about_resource: ., doesn't it say that it covers all content of the directory?
If so, then it could have separate excluding field.

all files in the directory are directly or indirectly (ie from a parent directory) documented or referenced in an ABOUT file

What if some files or subdirectories are temporary (like build subdirectory)? You need something like .gitignore.

@chinyeungli chinyeungli modified the milestones: version 4.1, Version 6 Sep 2, 2020
@chinyeungli
Copy link
Contributor

We have introduced the ignored_resources. Closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants