[Bug 249892] Review Request: bouml-doc - Documentation for the BOUML tool

bugzilla at redhat.com bugzilla at redhat.com
Wed Aug 1 17:26:41 UTC 2007


Please do not reply directly to this email. All additional
comments should be made in the comments box of this bug report.

Summary: Review Request: bouml-doc - Documentation for the BOUML tool


https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=249892





------- Additional Comments From debarshi.ray at gmail.com  2007-08-01 13:26 EST -------
(In reply to comment #11)

> (Maybe you have received the following comment, however
>  I rewrite)

Actually you are the first one to state it. :-)

> Well, why don't you write just as following?
> ----------------------------------------------------
> %files
> %defattr(-,root,root,-)
> %_datadir/doc/%name

I tend to use the more verbose form for the sake of readability. A quick glance
at the %files stanza reminds me that a directory (in this case
%{_datadir}/doc/%{name}) has been created by the package, and a short listing of
what it contains. I find this necessary since the %install stanza becomes too
'dirty' to realise what files are present with just a quick look at it.

However I don't prefer to list out every file and sub-directory if the list is
too long because that would defeat the initial idea.

%dir %{_datadir}/doc/%{name}
%{_datadir}/doc/%{name}/html/*
%{_datadir}/doc/%{name}/pdf/*
...is just enough to remind me that the documentation directory, named
%{_datadir}/doc/%{name}, contains the both the HTML and PDF representations.

Another example where I have followed this style is in gengetopt.spec
(https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=243607):
%dir %{_datadir}/%{name}
%{_datadir}/%{name}/getopt.c
%{_datadir}/%{name}/getopt1.c
%{_datadir}/%{name}/gnugetopt.h
Since there were only 3 files, I listed them explicitly.

If this does not violate the packaging guidelines and if you are compfortable
with it, then I would be happy to keep them this way. :-)

-- 
Configure bugmail: https://bugzilla.redhat.com/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.




More information about the package-review mailing list