Groups > linux.debian.maint.python > #16363

[backintime] Naming of documentation directory

Path	csiph.com!news.mixmin.net!news2.arglkargh.de!news.karotte.org!fu-berlin.de!news.servidellagleba.it!bofh.it!news.nic.it!robomod
From	c.buhtz@posteo.jp
Newsgroups	linux.debian.maint.python
Subject	[backintime] Naming of documentation directory
Date	Thu, 10 Oct 2024 11:10:01 +0200
Message-ID	<JvXlf-BB5-5@gated-at.bofh.it> (permalink)
X-Original-To	debian-python@lists.debian.org
X-Mailbox-Line	From debian-python-request@lists.debian.org Thu Oct 10 09:02:43 2024
Old-Return-Path	<c.buhtz@posteo.jp>
X-Amavis-Spam-Status	No, score=-9.298 tagged_above=-10000 required=5.3 tests=[BAYES_00=-2, LDO_WHITELIST=-5, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001] autolearn=ham autolearn_force=no
X-Policyd-Weight	using cached result; rate: -5.5
MIME-Version	1.0
Reply-To	debian-python@lists.debian.org
Mail-Reply-To	debian-python@lists.debian.org
Content-Type	text/plain; charset=US-ASCII; format=flowed
Content-Transfer-Encoding	7bit
X-Mailing-List	<debian-python@lists.debian.org> archive/latest/22427
List-ID	<debian-python.lists.debian.org>
List-URL	<https://lists.debian.org/debian-python/>
List-Archive	https://lists.debian.org/msgid-search/84468ce24fc194e8a2b2cff530dbec64@posteo.de
Approved	robomod@news.nic.it
Lines	53
Organization	linux.* mail to news gateway
Sender	robomod@news.nic.it
X-Original-Date	Thu, 10 Oct 2024 09:02:26 +0000
X-Original-Message-ID	<84468ce24fc194e8a2b2cff530dbec64@posteo.de>
Xref	csiph.com linux.debian.maint.python:16363

Show key headers only | View raw

Hello together,
I am upstream maintainer of "Back In Time" (src package: backintime 
[1]).

The source package results in two binary packages "backintime-common" 
(the CLI) and "backintime-qt" (the GUI).
Based on that package naming two folders are created in /usr/share/doc/*

     /usr/share/doc/backintime-common/
     /usr/share/doc/backintime-qt/

I would like to ask if there is any convention or policy that would 
forbid to have a third folder like this?

     /usr/share/doc/backintime/
     /usr/share/doc/backintime-common/
     /usr/share/doc/backintime-qt/

The reason is that the user itself is often not aware about the 
separation between "common" and "qt" and know this piece of software 
just as "backintime". The latter is also the name of the shell command.

More details. Here is a selection of files that get installed for both 
packages in /usr/share/doc/*

     /usr/share/doc/backintime-common/LICENSE
     /usr/share/doc/backintime-common/README.md.gz
     /usr/share/doc/backintime-common/changelog.Debian.gz
     /usr/share/doc/backintime-common/changelog.gz
     /usr/share/doc/backintime-common/copyright
     /usr/share/doc/backintime-common/examples/config-example-local.gz
     /usr/share/doc/backintime-common/examples/config-example-ssh.gz

     /usr/share/doc/backintime-qt/changelog.Debian.gz
     /usr/share/doc/backintime-qt/changelog.gz
     /usr/share/doc/backintime-qt/copyright

Especially the "example" files (config-example*) I would like to have in 
a general folder named "backintime". Currently I am adding (at upstream) 
some more other example files to the project.

Or would it make sense doing something like this?

     /usr/share/doc/backintime/
     /usr/share/doc/backintime/common/
     /usr/share/doc/backintime/qt/

Thanks in advance.

Best regards,
Christian Buhtz

[1] -- <https://tracker.debian.org/pkg/backintime>

Back to linux.debian.maint.python | Previous | Next | Find similar

Thread

[backintime] Naming of documentation directory c.buhtz@posteo.jp - 2024-10-10 11:10 +0200

csiph-web