diff options
| author | B. Watson <yalhcru@gmail.com> | 2022-05-02 13:30:17 -0400 |
|---|---|---|
| committer | B. Watson <yalhcru@gmail.com> | 2022-05-02 13:30:17 -0400 |
| commit | 4ec8325a4a6277836f334609d962928698068b64 (patch) | |
| tree | c702f60db2e6ef839551a826e310e97003a0b0cf | |
| parent | 8dfeeaccc2e5774f1c0650efbcf750bcc9eb1c8a (diff) | |
| download | sbo-maintainer-tools-4ec8325a4a6277836f334609d962928698068b64.tar.gz | |
minor doc update
| -rw-r--r-- | QUICKSTART | 7 | ||||
| -rw-r--r-- | README | 6 |
2 files changed, 10 insertions, 3 deletions
@@ -4,9 +4,12 @@ sbo-maintainer-tools installed: You can lint the build you're working on currently by running "sbolint" while cd'ed into its directory. +If you're about to upload a tarball to the SBo upload form, you can +lint it first by running "sbolint <build>.tar.gz". + You can lint the *package* (if you've already built one) by running -"sbopkglint" in the build directory (and entering your password, if -you're asked for one). +"sbopkglint" in the build directory (and entering your user's +password, if you're asked for one). You can also lint any package by giving its filename as an argument to sbopkglint. If you have a bunch of already-built packages, you can @@ -1,5 +1,5 @@ sbo-maintainer-tools --------------------- +==================== These are "lint" tools to make life easier for SlackBuilds.org maintainers and admins. They check your builds and packages for @@ -8,6 +8,7 @@ will be less work for the admins to do when reviewing your build for approval. Included tools: +--------------- - sbolint: checks your SlackBuild, README, .info file, and slack-desc. @@ -25,6 +26,7 @@ tests aren't perfect, of course, and there are exceptions to almost every rule). Installation: +------------- The easiest way to install sbo-maintainer-tools is to install them from SBo (system/sbo-maintainer-tools). The SBo build might be out @@ -44,6 +46,7 @@ directory in your $PATH (e.g. if you keep your local scripts in ~/bin). Git Hook: +--------- To use the git hook, copy pre-commit-sbolint to .git/hooks/pre-commit in your git work tree (wherever you cloned the SBo repository), @@ -61,6 +64,7 @@ If you find yourself having to do this often, please contact the SBo admins and explain the situation; it may mean sbolint needs updating. Documentation: +-------------- For more information, see the sbolint and sbopkglint man pages (or run the scripts with --doc; it's the same thing). There's also a |