Linux Archive

Linux Archive (http://www.linux-archive.org/)
-   Fedora Development (http://www.linux-archive.org/fedora-development/)
-   -   adding manual to existing package - soft review ? (http://www.linux-archive.org/fedora-development/520874-adding-manual-existing-package-soft-review.html)

David Timms 05-01-2011 10:48 PM

adding manual to existing package - soft review ?
 
Hi, I'm adding a subpackage -manual to audacity to include the
additional manual archive. It links from the help menu items if it is
installed, or else points you to the in development online version.

I already made a mistake and included manual files in both the main and
sub package. The spec change [1] I've committed fixes this.

The -manual package can be used by either audacity or
audacity-freeworld. At the moment the manual spec marks up the
datadair/audacity folder and hence dually owns it with audacity if that
is installed. Reading the packaging examples, seems that this can
sometimes be OK, but does what I've done make sense ?

Or should I Require the audacity (or audacity-freeworld) package, and
not add the datadir/audacity folder to the -manual directory.

Thirdly, vague recollection of one source/package. Should the -manual
just be a separate package anyway (review?) ? It's likely to be updated
more often, but not necessarily in sync with the program.

4. Being new to git/fedpkg, how can I tell which branch I'm on ?

[1]
<http://pkgs.fedoraproject.org/gitweb/?p=audacity.git;a=blob_plain;f=audacity.spec;hb=f1 4/master>

--
devel mailing list
devel@lists.fedoraproject.org
https://admin.fedoraproject.org/mailman/listinfo/devel

Ville Skyttä 05-02-2011 08:04 AM

adding manual to existing package - soft review ?
 
On 05/02/2011 01:48 AM, David Timms wrote:
> The -manual package can be used by either audacity or
> audacity-freeworld. At the moment the manual spec marks up the
> datadair/audacity folder and hence dually owns it with audacity if that
> is installed. Reading the packaging examples, seems that this can
> sometimes be OK, but does what I've done make sense ?

Seems to make sense if you don't want to add a dependency to either package.

> Or should I Require the audacity (or audacity-freeworld) package, and
> not add the datadir/audacity folder to the -manual directory.

No opinion on that (don't know enough about it), but if you do, you can
accomplish the "or" by adding a dependency on /usr/bin/audacity.

> Thirdly, vague recollection of one source/package. Should the -manual
> just be a separate package anyway (review?) ? It's likely to be updated
> more often, but not necessarily in sync with the program.

I'd lean towards making it a completely separate subpackage then. But
whichever way you choose, the manual should be kept in sync with the
"main" package so that it documents whatever is in the main package, not
earlier nor newer version of the software.

If the intent is to make the manual installable without installing
audacity itself, I'd also consider installing the manual to let's say
/usr/share/doc/audacity-manual and patching the main packages to use it
from there, I think that's a location where people are more likely to
find it than /usr/share/audacity/help.

> 4. Being new to git/fedpkg, how can I tell which branch I'm on ?

"git branch".

If you use bash, here's how you get it shown directly in your prompt:
http://fedoraproject.org/wiki/Git_Quickref#Display_current_branch_in_bash
--
devel mailing list
devel@lists.fedoraproject.org
https://admin.fedoraproject.org/mailman/listinfo/devel

Niels de Vos 05-02-2011 09:30 AM

adding manual to existing package - soft review ?
 
> Date: Mon, 02 May 2011 08:48:26 +1000
> From: David Timms <dtimms@iinet.net.au>
> Subject: adding manual to existing package - soft review ?
> To: Development discussions related to Fedora
> * * * *<devel@lists.fedoraproject.org>
> Message-ID: <4DBDE33A.9030704@iinet.net.au>
> Content-Type: text/plain; charset=ISO-8859-1; format=flowed
>
> Hi, I'm adding a subpackage -manual to audacity to include the
> additional manual archive. It links from the help menu items if it is
> installed, or else points you to the in development online version.
>
> I already made a mistake and included manual files in both the main and
> sub package. The spec change [1] I've committed fixes this.
>
> The -manual package can be used by either audacity or
> audacity-freeworld. At the moment the manual spec marks up the
> datadair/audacity folder and hence dually owns it with audacity if that
> is installed. Reading the packaging examples, seems that this can
> sometimes be OK, but does what I've done make sense ?

In your updated spec the manual (from the URL) does not contain a
version. When creating a sub-package, both audacity and
audacity-manual will have the same version. I do not think this is
always correct, you probably want to use the manual from the same
version, or create a separate package if versions can be mixed.

> Or should I Require the audacity (or audacity-freeworld) package, and
> not add the datadir/audacity folder to the -manual directory.

If the manual does not need to be the same version as audacity and/or
audacity-freeworld, I guess that using a Requires and creating an
independent sub-package is the best choice.

> Thirdly, vague recollection of one source/package. Should the -manual
> just be a separate package anyway (review?) ? It's likely to be updated
> more often, but not necessarily in sync with the program.

See above.

> 4. Being new to git/fedpkg, how can I tell which branch I'm on ?

$ fedpkg switch-branch -l
or
$ git branch
the active branch is marked with a *.

More git/fedpkg can be found on
http://fedoraproject.org/wiki/Using_Fedora_GIT or even
http://fedoraproject.org/wiki/Git_Quickref#Display_current_branch_in_bash.

Cheers,
Niels


> [1]
> <http://pkgs.fedoraproject.org/gitweb/?p=audacity.git;a=blob_plain;f=audacity.spec;hb=f1 4/master>
--
devel mailing list
devel@lists.fedoraproject.org
https://admin.fedoraproject.org/mailman/listinfo/devel


All times are GMT. The time now is 07:03 AM.

VBulletin, Copyright ©2000 - 2014, Jelsoft Enterprises Ltd.
Content Relevant URLs by vBSEO ©2007, Crawlability, Inc.