Bug#491030: bash-doc: doesn't include documentation

dEbian Bugs RC

severity 491030 grave
thanks



IMHO examples don't account for documentation.


documentation
n 1: confirmation that some fact or statement is true [syn: certification,
corroboration]
2: program listings or technical manuals describing the
operation and use of programs [syn: software
documentation]
3: documentary validation; "his documentation of the results
was excellent"; "the strongest support for this this view
is the work of Jones" [syn: support]

Besides the changelogs and copyright, this package consists only of
examples and the bashref file. The contents of the bashref file are:

%%%
Document: bashref
Title: Bash Reference Manual
Author: Chet Ramey
Abstract: Bash is an sh-compatible command language interpreter that
executes commands read from the standard input or from a file. Bash
also incorporates useful features from the Korn and C shells (ksh and
csh). Section: Apps/Shells

Format: pdf
Files: /usr/share/doc/bash/bashref.pdf
%%%

This is only the description of the Bash reference manual, and a
reference to a file that isn't include in the package. If the bash
reference manual isn't included then the bash reference manual is
missing and should be included. If it is not meant to be included then
bashref documents nothing and the package contains no documentation. If
you insist that it contains documentation despite the examples not being
documentation and the other files not being documentation then
here is the file listing:


Filelist of package bash-doc in {lenny,sid} of architecture all



/usr/share/doc-base/bashref
/usr/share/doc/bash-doc/changelog.Debian.gz
/usr/share/doc/bash-doc/changelog.gz
/usr/share/doc/bash-doc/copyright
/usr/share/doc/bash-doc/examples
/usr/share/doc/bash/examples/INDEX.html
/usr/share/doc/bash/examples/INDEX.txt
/usr/share/doc/bash/examples/bashdb/PERMISSION
/usr/share/doc/bash/examples/bashdb/README
/usr/share/doc/bash/examples/bashdb/bashdb
/usr/share/doc/bash/examples/bashdb/bashdb.el
/usr/share/doc/bash/examples/complete/bashcc-1.0.1.tar.gz
/usr/share/doc/bash/examples/complete/complete-examples
/usr/share/doc/bash/examples/complete/complete.freebsd
/usr/share/doc/bash/examples/complete/complete.gnu-longopt
/usr/share/doc/bash/examples/complete/complete.ianmac
/usr/share/doc/bash/examples/complete/complete2.ianmac
/usr/share/doc/bash/examples/functions/array-stuff
/usr/share/doc/bash/examples/functions/array-to-string
/usr/share/doc/bash/examples/functions/autoload
/usr/share/doc/bash/examples/functions/autoload.v2
/usr/share/doc/bash/examples/functions/autoload.v3
/usr/share/doc/bash/examples/functions/basename
/usr/share/doc/bash/examples/functions/basename2
/usr/share/doc/bash/examples/functions/coproc.bash
/usr/share/doc/bash/examples/functions/coshell.README
/usr/share/doc/bash/examples/functions/coshell.bash
/usr/share/doc/bash/examples/functions/csh-compat
/usr/share/doc/bash/examples/functions/dirfuncs
/usr/share/doc/bash/examples/functions/dirname
/usr/share/doc/bash/examples/functions/emptydir
/usr/share/doc/bash/examples/functions/exitstat
/usr/share/doc/bash/examples/functions/external
/usr/share/doc/bash/examples/functions/fact
/usr/share/doc/bash/examples/functions/fstty
/usr/share/doc/bash/examples/functions/func
/usr/share/doc/bash/examples/functions/gethtml
/usr/share/doc/bash/examples/functions/getoptx.bash
/usr/share/doc/bash/examples/functions/inetaddr
/usr/share/doc/bash/examples/functions/inpath
/usr/share/doc/bash/examples/functions/isnum.bash
/usr/share/doc/bash/examples/functions/isnum2
/usr/share/doc/bash/examples/functions/isvalidip
/usr/share/doc/bash/examples/functions/jdate.bash
/usr/share/doc/bash/examples/functions/jj.bash
/usr/share/doc/bash/examples/functions/keep
/usr/share/doc/bash/examples/functions/ksh-cd
/usr/share/doc/bash/examples/functions/ksh-compat-test
/usr/share/doc/bash/examples/functions/kshenv
/usr/share/doc/bash/examples/functions/login
/usr/share/doc/bash/examples/functions/lowercase
/usr/share/doc/bash/examples/functions/manpage
/usr/share/doc/bash/examples/functions/mhfold
/usr/share/doc/bash/examples/functions/notify.bash
/usr/share/doc/bash/examples/functions/pathfuncs
/usr/share/doc/bash/examples/functions/recurse
/usr/share/doc/bash/examples/functions/repeat2
/usr/share/doc/bash/examples/functions/repeat3
/usr/share/doc/bash/examples/functions/seq
/usr/share/doc/bash/examples/functions/seq2
/usr/share/doc/bash/examples/functions/shcat
/usr/share/doc/bash/examples/functions/shcat2
/usr/share/doc/bash/examples/functions/sort-pos-params
/usr/share/doc/bash/examples/functions/substr
/usr/share/doc/bash/examples/functions/substr2
/usr/share/doc/bash/examples/functions/term
/usr/share/doc/bash/examples/functions/whatis
/usr/share/doc/bash/examples/functions/whence
/usr/share/doc/bash/examples/functions/which
/usr/share/doc/bash/examples/functions/xalias.bash
/usr/share/doc/bash/examples/functions/xfind.bash
/usr/share/doc/bash/examples/misc/aliasconv.bash
/usr/share/doc/bash/examples/misc/aliasconv.sh
/usr/share/doc/bash/examples/misc/cshtobash
/usr/share/doc/bash/examples/misc/suncmd.termcap
/usr/share/doc/bash/examples/obashdb/PERMISSION
/usr/share/doc/bash/examples/obashdb/README
/usr/share/doc/bash/examples/obashdb/bashdb
/usr/share/doc/bash/examples/obashdb/bashdb.fns
/usr/share/doc/bash/examples/obashdb/bashdb.pre
/usr/share/doc/bash/examples/scripts.noah/PERMISSION
/usr/share/doc/bash/examples/scripts.noah/README
/usr/share/doc/bash/examples/scripts.noah/aref.bash
/usr/share/doc/bash/examples/scripts.noah/bash.sub.bash
/usr/share/doc/bash/examples/scripts.noah/bash_version.bash
/usr/share/doc/bash/examples/scripts.noah/meta.bash
/usr/share/doc/bash/examples/scripts.noah/mktmp.bash
/usr/share/doc/bash/examples/scripts.noah/number.bash
/usr/share/doc/bash/examples/scripts.noah/prompt.bash
/usr/share/doc/bash/examples/scripts.noah/remap_keys.bash
/usr/share/doc/bash/examples/scripts.noah/require.bash
/usr/share/doc/bash/examples/scripts.noah/send_mail.bash
/usr/share/doc/bash/examples/scripts.noah/shcat.bash
/usr/share/doc/bash/examples/scripts.noah/source.bash
/usr/share/doc/bash/examples/scripts.noah/string.bash
/usr/share/doc/bash/examples/scripts.noah/stty.bash
/usr/share/doc/bash/examples/scripts.noah/y_or_n_p.bash
/usr/share/doc/bash/examples/scripts.v2/PERMISSION
/usr/share/doc/bash/examples/scripts.v2/README
/usr/share/doc/bash/examples/scripts.v2/arc2tarz
/usr/share/doc/bash/examples/scripts.v2/bashrand
/usr/share/doc/bash/examples/scripts.v2/cal2day.bash
/usr/share/doc/bash/examples/scripts.v2/cdhist.bash
/usr/share/doc/bash/examples/scripts.v2/corename
/usr/share/doc/bash/examples/scripts.v2/fman
/usr/share/doc/bash/examples/scripts.v2/frcp
/usr/share/doc/bash/examples/scripts.v2/lowercase
/usr/share/doc/bash/examples/scripts.v2/ncp
/usr/share/doc/bash/examples/scripts.v2/newext
/usr/share/doc/bash/examples/scripts.v2/nmv
/usr/share/doc/bash/examples/scripts.v2/pages
/usr/share/doc/bash/examples/scripts.v2/pf
/usr/share/doc/bash/examples/scripts.v2/pmtop
/usr/share/doc/bash/examples/scripts.v2/ren
/usr/share/doc/bash/examples/scripts.v2/rename
/usr/share/doc/bash/examples/scripts.v2/repeat
/usr/share/doc/bash/examples/scripts.v2/shprof
/usr/share/doc/bash/examples/scripts.v2/untar
/usr/share/doc/bash/examples/scripts.v2/uudec
/usr/share/doc/bash/examples/scripts.v2/uuenc
/usr/share/doc/bash/examples/scripts.v2/vtree
/usr/share/doc/bash/examples/scripts.v2/where
/usr/share/doc/bash/examples/scripts/adventure.sh
/usr/share/doc/bash/examples/scripts/bcsh.sh
/usr/share/doc/bash/examples/scripts/cat.sh
/usr/share/doc/bash/examples/scripts/center
/usr/share/doc/bash/examples/scripts/dd-ex.sh
/usr/share/doc/bash/examples/scripts/fixfiles.bash
/usr/share/doc/bash/examples/scripts/hanoi.bash
/usr/share/doc/bash/examples/scripts/inpath
/usr/share/doc/bash/examples/scripts/krand.bash
/usr/share/doc/bash/examples/scripts/line-input.bash
/usr/share/doc/bash/examples/scripts/nohup.bash
/usr/share/doc/bash/examples/scripts/precedence
/usr/share/doc/bash/examples/scripts/randomcard.bash
/usr/share/doc/bash/examples/scripts/scrollbar
/usr/share/doc/bash/examples/scripts/scrollbar2
/usr/share/doc/bash/examples/scripts/self-repro
/usr/share/doc/bash/examples/scripts/showperm.bash
/usr/share/doc/bash/examples/scripts/shprompt
/usr/share/doc/bash/examples/scripts/spin.bash
/usr/share/doc/bash/examples/scripts/timeout
/usr/share/doc/bash/examples/scripts/vtree2
/usr/share/doc/bash/examples/scripts/vtree3
/usr/share/doc/bash/examples/scripts/vtree3a
/usr/share/doc/bash/examples/scripts/websrv.sh
/usr/share/doc/bash/examples/scripts/xterm_title
/usr/share/doc/bash/examples/scripts/zprintf
/usr/share/doc/bash/examples/startup-files/Bash_aliases
/usr/share/doc/bash/examples/startup-files/Bash_profile
/usr/share/doc/bash/examples/startup-files/Bashrc.bfox
/usr/share/doc/bash/examples/startup-files/README
/usr/share/doc/bash/examples/startup-files/apple/README
/usr/share/doc/bash/examples/startup-files/apple/aliases
/usr/share/doc/bash/examples/startup-files/apple/bash.defaults
/usr/share/doc/bash/examples/startup-files/apple/environment
/usr/share/doc/bash/examples/startup-files/apple/login
/usr/share/doc/bash/examples/startup-files/apple/logout
/usr/share/doc/bash/examples/startup-files/apple/rc
/usr/share/doc/bash/examples/startup-files/bash-profile
/usr/share/doc/bash/examples/startup-files/bashrc


And if you insist to apply definition 1, despite the package being
meant to be software documentation, then the examples aren't meant to
confirm that a statement is true, nor it is the bashref file, so it is
not documentation. And if you insist that examples can confirm that a
statement is true, despite the package being meant to be software
documentation, then you have know which statement is to be confirmed to
be true and then a test (from the shell or writing your own script) can
do as well, the examples would be of no purpose and the package would
contain no documentation. And if you insist to apply definition 3:


validation
n 1: the act of validating; finding or testing the truth of
something [syn: proof, substantiation]
2: the cognitive process of establishing a valid proof [syn: establishment]

Which points back to definition 1.

Happy packaging.
Processing commands for [email protected]:

Bug#491030: bash-doc contains no documentation
Severity set to `grave' from `grave'

Stopping processing here.

Please contact me if you need assistance.

Debian bug tracking system administrator
(administrator, Debian Bugs database)