Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 500606 - sys-apps/openrc: runscript man page: please describe checkpath options more verbosely
Summary: sys-apps/openrc: runscript man page: please describe checkpath options more v...
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Hosted Projects
Classification: Unclassified
Component: OpenRC (show other bugs)
Hardware: All Linux
: Normal enhancement (vote)
Assignee: OpenRC Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 481182
  Show dependency tree
 
Reported: 2014-02-07 10:02 UTC by Lars Wendler (Polynomial-C) (RETIRED)
Modified: 2014-07-13 16:33 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Lars Wendler (Polynomial-C) (RETIRED) gentoo-dev 2014-02-07 10:02:57 UTC
Current runscript man page says the following about checkpath:

     checkpath [-D, --directory-truncate] [-d, --directory] [-F,
             --file-truncate] [-f, --file] [-p, --pipe] [-m, --mode mode] [-o,
             -owner owner] path ...
             Checks to see if the path exists, is of the right type, owned by
             the right people and has the correct access modes. If not, then
             it corrects the path.

     checkpath
             [-W, --writable] path
              checks to see if the path is writable.


It's nice that we get the list of available options but leaves us with what exactly the options are good for.
For example what exactly do the "--directory-truncate", "--file-truncate" and "--pipe" options?
Can we use --mode with only three digits (750) or do we have to submit four digits (0750)?
Can we use checkpath for checking if a file is missing and _not_ creating that file but with return code <0?

Please make the description of checkpath more verbose (for each option) and maybe give a couple of examples. It would also be fine to give some hints what checkpath can not be used for.

Thanks!
Comment 1 Alexander Vershilov (RETIRED) gentoo-dev 2014-02-15 23:53:21 UTC
Will it work?

https://github.com/OpenRC/openrc/pull/15
Comment 2 Alexander Vershilov (RETIRED) gentoo-dev 2014-02-15 23:53:57 UTC
(In reply to Alexander Vershilov from comment #1)
> Will it work?
> 
> https://github.com/OpenRC/openrc/pull/15

I'll try to answer other questions in next patch.
Comment 3 Alexander Vershilov (RETIRED) gentoo-dev 2014-02-16 00:10:28 UTC
> Can we use checkpath for checking if a file is missing and _not_ creating that file but with return code <0?

it's not possible now, so were not added to manual. Is it required option, in this case we may add such feature.
Comment 4 William Hubbs gentoo-dev 2014-07-13 16:32:56 UTC
The pull request was merged in commit d59737a, and I added more
clarification in commit 4014124.
These will be included in OpenRc-0.13.
Comment 5 William Hubbs gentoo-dev 2014-07-13 16:33:53 UTC
Let me know if more clarification is needed.