On Sun, 25 Sep 2022, William PC wrote:
Hi,
I'm trying to prepear a SlackBuild for submiting.
However when I run sbopklint it fails:
Running test: 10-docs...
--- useless-looking install instructions in doc dir: .../ INSTALL.md
....../INSTALL
FAILED
If the INSTALL (or INSTALL.md) files contain information that's
actually useful to a user of your package (and not just build
instructions for you, the packager), go ahead & leave them in the
package, and ignore the FAILED message.
If the install instructions would be meaningless to someone who isn't
compiling/building the software (e.g. if it describes how to use
./configure, or documents options to cmake), don't include it in the
package. Users who build/install your package don't need instructions
on how to run ./configure or cmake, your SlackBuild already ran it
for them.
I thought maybe I should not include this files but I saw that they are
included in several packages
mostly of them include the INSTALL and a few INSTALL.md such as the
pipewire.
In the past, before sbolint, most people just left the INSTALL docs
in the doc dir, whether they're useful or not. They don't *hurt*
anything, they just take up a bit of the user's disk space, and waste
a bit of his time, if he reads them. There are still a lot of packages
that include them. I'm trying to convince everyone to tighten this up
a bit, and not include useless instructions in packages.
_______________________________________________
SlackBuilds-users mailing list
SlackBuilds-users@slackbuilds.org
https://lists.slackbuilds.org/mailman/listinfo/slackbuilds-users
Archives - https://lists.slackbuilds.org/pipermail/slackbuilds-users/
FAQ - https://slackbuilds.org/faq/
