Community Packages

Please read this before reporting a bug:
https://wiki.archlinux.org/title/Bug_reporting_guidelines

Do NOT report bugs when a package is just outdated, or it is in the AUR. Use the 'flag out of date' link on the package page, or the Mailing List.

REPEAT: Do NOT report bugs for outdated packages!
Tasklist

FS#27620 - [shorewall] Please include docs

Attached to Project: Community Packages
Opened by Das (DasFox) - Sunday, 18 December 2011, 22:48 GMT
Last edited by Evangelos Foutras (foutrelis) - Friday, 30 December 2011, 16:40 GMT
Task Type General Gripe
Category Packages
Status Closed
Assigned To Evangelos Foutras (foutrelis)
Architecture All
Severity Low
Priority Normal
Reported Version
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 0
Private No

Details

Description: No /usr/share/docs for shorewall

Shorewall has very important information and help that comes with the Docs, these should not be overlooked and removed from the source but installed into /usr/share/docs

This is a great disservice by not including this document information and I hope you'll please include it.

Having the documentation on another distro helped me greatly to get shorewall going, without it, I would of been lost, it's not easy digging through Shorewall's site to find this information and the docs are invaluable....


THANKS
This task depends upon

Closed by  Evangelos Foutras (foutrelis)
Friday, 30 December 2011, 16:40 GMT
Reason for closing:  Fixed
Additional comments about closing:  Will be fixed in the next release.
Comment by Karol Błażewicz (karol) - Sunday, 18 December 2011, 23:52 GMT
Are you sure upstream provides docs? I see only man pages and samples.
Comment by Das (DasFox) - Monday, 19 December 2011, 00:45 GMT
When you say upstream you mean the developer?

For me the Samples were a life safer...

Sorry, saying documentation when that wasn't correct for Shorewall...

The point is many packages/source have different information, Authors, changelogs, readmes, and docs to learn, samples, etc...

I've been into Linux for many years, to me the Linux way first, is to check the /doc section, then man, then go hunting else where...

Docs do not take up that much space, so please, let's include what there is for every pacakge...


THANKS
Comment by Karol Błażewicz (karol) - Monday, 19 December 2011, 00:50 GMT
I'm not sure I understand, shorewall package does include samples under /usr/share/shorewall/Samples: http://www.archlinux.org//packages/community/any/shorewall/files/

Some Arch packages have docs moved to a separate foo-docs package for various reasons, but the documentation is provided.
Comment by Das (DasFox) - Monday, 19 December 2011, 12:22 GMT
/usr/share/shorewall/Samples/ is not the correct /path these should be placed in.

The Samples are suppose to be in;

/usr/share/doc/shorewall/Samples/


Thank you...
Comment by Evangelos Foutras (foutrelis) - Monday, 19 December 2011, 17:01 GMT
Sounds reasonable. The Samples directory will be under /usr/share/doc/shorewall/ in the next release.
Comment by Das (DasFox) - Tuesday, 20 December 2011, 00:07 GMT
Hi,

Thanks and anything else please that looks documented related...

Loading...