aboutcode-org / aboutcode-org/extractcode

Improve doc for extractcode --ignore option

未关闭
#59 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
39
派生
23
PR 合并指标
30 天内没有已合并 PR

描述

The extractcode doc at https://scancode-toolkit.readthedocs.io/en/stable/tutorials/how_to_extract_archives.html doc doesn't mention the "--ignore" option at all. it's quite an important option to avoid wasting time on unnecessary files and also for preventing extractcode falling over when it encountered an invalid/corrupt archive file that isn't required.

When documenting this flag, it'd be helpful to explain the interaction between the extractcode --ignore and the scancode parameter of the same name. Specifically, having just spent several hours adding debug statements to the source code to understand why my extractcode --ignore globs weren't working, the piece of info that would really help is to know that the extractcode ignores do NOT apply to paths within the archives (e.g. `my-archive.tar/tests/foo` is extracted even if I use `extractcode --ignore=*/tests/*`) but only to the decision about which archives to unpack.

(aside: I was wondering about create an additional FR for applying extractcode ignores to individual files - could make it a LOT faster if extractcode didn't waste time writing to-be-ignored files such as */tests/* to disk only to be later ignored by scancode... if you think that's a good idea we could create an issue for that too)

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。