Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 257592 - app-admin/webapp-config-1.50.16-r3: clarify man page with respect to --default-dirs and --virtual-files
Summary: app-admin/webapp-config-1.50.16-r3: clarify man page with respect to --defaul...
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All All
: High minor (vote)
Assignee: Devan Franchini (RETIRED)
URL:
Whiteboard:
Keywords: InVCS
Depends on:
Blocks:
 
Reported: 2009-02-04 13:08 UTC by Nico R.
Modified: 2015-07-06 00:55 UTC (History)
1 user (show)

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


Attachments
Fixes incorrect flag in webapp-config man page. (default-dirs_man_entry_flag.patch,459 bytes, patch)
2013-03-27 20:48 UTC, Devan Franchini (RETIRED)
Details | Diff
Fixes incorrect flag in webapp-config man page. (default-dirs_man_entry_flag_xml.patch,568 bytes, patch)
2013-03-28 00:19 UTC, Devan Franchini (RETIRED)
Details | Diff
Fixes incorrect flag in webapp-config man page. (alternative w/line separation) (0001-webapp-config.8.xml-Changes-vd-flag-to-dd.patch,1.12 KB, patch)
2013-08-05 22:27 UTC, Devan Franchini (RETIRED)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Nico R. 2009-02-04 13:08:06 UTC
The man page webapp-config.8 for app-admin/webapp-config-1.50.16-r3 contains a typo: it lists the short form of ‘--default-dirs’ as ‘--vd’ instead of ‘--dd’.

It should also note clearly that ‘--dd’ is the short form of ‘--default-dirs’, as is ‘--vf’ for ‘--virtual-files’, but that these are two sets of options, and not all of them are equal. Perhaps this can be clarified with an additional line break between these two options to make the distinction more apparent.

Thanks.
Comment 1 Maciej Mrozowski gentoo-dev 2010-10-04 00:08:22 UTC
Does the same apply for webapp.eclass manpage from eclass-manpages package?
Be advised that webapp-config no longer installs manual page for eclass.
Comment 2 Devan Franchini (RETIRED) gentoo-dev 2013-03-27 20:48:36 UTC
Created attachment 343470 [details, diff]
Fixes incorrect flag in webapp-config man page.
Comment 3 Anthony Basile gentoo-dev 2013-03-27 23:33:35 UTC
(In reply to comment #2)
> Created attachment 343470 [details, diff] [details, diff]
> Fixes incorrect flag in webapp-config man page.

this is a patch directly against the man page.  We need a patch against the repository's .xml file: webapp-config/doc/webapp-config.8.xml

cd into the git repo directory.  make the changes.  commit them locally.  then do git format-patch HEAD^
Comment 4 Devan Franchini (RETIRED) gentoo-dev 2013-03-28 00:19:33 UTC
Created attachment 343484 [details, diff]
Fixes incorrect flag in webapp-config man page.
Comment 5 Devan Franchini (RETIRED) gentoo-dev 2013-05-26 00:16:06 UTC
I also need to edit the man page to reflect the removal of the --cp flag.
Comment 6 Anthony Basile gentoo-dev 2013-08-03 14:45:23 UTC
(In reply to Devan Franchini from comment #5)
> I also need to edit the man page to reflect the removal of the --cp flag.

Can we get this done so I can commit it for the next relase.
Comment 7 Devan Franchini (RETIRED) gentoo-dev 2013-08-05 19:45:55 UTC
(In reply to Anthony Basile from comment #6)
> (In reply to Devan Franchini from comment #5)
> > I also need to edit the man page to reflect the removal of the --cp flag.
> 
> Can we get this done so I can commit it for the next relase.

Editing the man page to reflect the removal of the --cp flag is complete. I do believe I need to alter one more thing in this bug to show an additional line break between the two options.
Comment 8 Devan Franchini (RETIRED) gentoo-dev 2013-08-05 22:27:19 UTC
Created attachment 355200 [details, diff]
Fixes incorrect flag in webapp-config man page. (alternative w/line separation)

This patch includes a new line between the virtual-files, and default-dirs flags to show a distinction between the two.

Warning: 

This was done by adding a </varlistentry> and another <varlistentry> between the --dd flag, and the --virtual-files flag. I'm including this warning because <varlistentry> expects a <listitem> to go with it as well. It should work but I'm not 100% certain, so I believe it should be checked before being commited. I used a tool to change the xml to html, and it warned me about this error. I had to skip validation in order for it to convert it. 

This is why I made this patch an alternative instead of deprecating the previous patch.
Comment 9 Devan Franchini (RETIRED) gentoo-dev 2014-09-23 17:08:31 UTC
Neither of those patches have been applied and a proper fix will be in the experimental branch of webapp-config shortly.