Executable example scripts in documentation
Richard W.M. Jones
rjones at redhat.com
Fri Mar 6 10:05:55 UTC 2009
https://bugzilla.redhat.com/show_bug.cgi?id=487527#c3
The above review is blocked because I want to include three example
scripts in the documentation, and I want them to be executable so that
people can run them without an unnecessary extra step.
rpmlint warns about this (spurious-executable-perm). But I think rpmlint
is wrong.
There are scant guidelines about this - just one oblique reference in
a "packaging mistakes" page. There is no convincing explanation I can
find as to why including an executable script in documentation is a
bad thing.
We also have lots of executable examples already, and quite rightly so:
find /usr/share/doc/ -perm /111 -a \! -type d
Rich.
--
Richard Jones, Emerging Technologies, Red Hat http://et.redhat.com/~rjones
Read my OCaml programming blog: http://camltastic.blogspot.com/
Fedora now supports 68 OCaml packages (the OPEN alternative to F#)
http://cocan.org/getting_started_with_ocaml_on_red_hat_and_fedora
More information about the fedora-devel-list
mailing list