#293: bibdocfile: strengthen documentation
-----------------------+----------------------------------------------------
Reporter: simko | Owner: skaplun
Type: defect | Status: new
Priority: critical | Milestone: v1.0
Component: WebSubmit | Version:
Keywords: |
-----------------------+----------------------------------------------------
The documentation of bibdocfile, and its counterpart about FFT in
BibUpload Admin Guide, should be strengthened. Two examples:
1) The `--hard-delete` option is mentioned in the documentation but does
not seem to work (which is a non-doc-related issue) but while fixing that,
we should probably clarify a bit its documentation WRT `--expunge` e.g. to
underline `--with-versions` and `--with-format` and stuff. Otherwise
difference between //applies to all revisions// (delete) and //applies to
matched revisions// (hard-delete) may be somewhat subtle.
{{{
$ (/opt/cds-invenio/bin/bibdocfile --help | grep hard-delete)
--hard-delete hard-delete the matched documents (applies to
matched
--purge purge (i.e. hard-delete previous versions) the
matched
--expunge expunge (i.e. hard-delete any version and formats)
the
specifies the version(s) to be used with hard-
delete,
$ /opt/cds-invenio/bin/bibdocfile --docid 14 --hard-delete
ERROR: Action hard_delete is not valid
}}}
2) The use of FFT $o HIDDEN flag is not documented in the BibUpload Admin
Guide. It will be good to document this even if we may change $r/$o
behaviour later.
--
Ticket URL: <http://invenio-software.org/ticket/293>
Invenio <http://invenio-software.org>
