[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#39830: marked as done ([AMENDMENT 30/10/2002] get rid of undocumented(7) symlinks)



Your message dated Sun, 17 Nov 2002 22:31:57 -0500
with message-id <E18Dcdh-0003Pl-00@auric.debian.org>
and subject line Bug#39830: fixed in debian-policy 3.5.8.0
has caused the attached Bug report to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what I am
talking about this indicates a serious mail system misconfiguration
somewhere.  Please contact me immediately.)

Debian bug tracking system administrator
(administrator, Debian Bugs database)

--------------------------------------
Received: (at submit) by bugs.debian.org; 20 Jun 1999 23:38:35 +0000
Received: (qmail 11335 invoked from network); 20 Jun 1999 23:38:33 -0000
Received: from aiur.rhein.de (HELO postfix.rhein.de) (193.175.27.2)
  by master.debian.org with SMTP; 20 Jun 1999 23:38:33 -0000
Received: by postfix.rhein.de (Postfix, from userid 5)
	id 9581012776; Mon, 21 Jun 1999 01:38:31 +0200 (MET DST)
Received: from luv (luv)
	by aiur (rbsmtp 2.3pl8bMS);
	Mon Jun 21 01:38:31 1999
	using /var/spool/bsmtp/out/q14810.03.929921911
Received: from spinnaker.rhein.de (roland@spinnaker.rhein.de [193.175.27.129])
	by luv.rhein.de (8.9.3/8.9.3/Debian/GNU) with ESMTP id BAA03838;
	Mon, 21 Jun 1999 01:36:22 +0200
Received: (from roland@localhost)
	by spinnaker.rhein.de (8.9.3/8.9.3/Debian/GNU) id BAA09700;
	Mon, 21 Jun 1999 01:36:19 +0200
Date: Mon, 21 Jun 1999 01:36:19 +0200
Message-Id: <199906202336.BAA09700@spinnaker.rhein.de>
From: roland@spinnaker.de
Subject: debian-policy: [PROPOSED]: get rid of undocumented(7) symlinks
To: submit@bugs.debian.org
X-Mailer: bug 3.2.2
Sender: roland@spinnaker.rhein.de

Package: debian-policy
Version: 2.5.1.0
Severity: wishlist

I propose the following change to chapter "6.1 Manual pages":

----------------------- schnipp --------------------------------
--- policy.sgml	Tue Apr 27 18:14:00 1999
+++ policy.sgml	Mon Jun 21 01:17:54 1999
@@ -2868,20 +2868,14 @@
 	  page'.</p>
 	  
 	<p>
-	  If no manual page is available for a particular program,
-	  utility or function and this is reported as a bug on
-	  debian-bugs, a symbolic link from the requested manual page
-	  to the <manref name="undocumented" section="7"> manual page
-	  should be provided.  This symbolic link can be created from
-	  <tt>debian/rules</tt> like this:
-	  <example>
-	    ln -s ../man7/undocumented.7.gz \
-	    debian/tmp/usr/man/man[1-9]/the_requested_manpage.[1-9].gz
-	  </example> 
-	  This manpage claims that the lack of a manpage has been
-	  reported as a bug, so you may only do this if it really has
-	  (you can report it yourself, if you like).  Do not close the
-	  bug report until a proper manpage is available.</p>
+	  There must be a manual page at least for every program.  If
+	  no manual page is available, this is considered as a bug and
+	  should be reported to the bug tracking system.  Do not close
+	  the bug report until a proper manpage is available.  To
+	  avoid duplicate bug reports about missing manual pages, you
+	  should inform the user that you know about the missing
+	  manual page in
+	  <tt>/usr/doc/<var>package</var>/TODO.Debian</tt>.</p>
 	  
 	<p>
 	  You may forward a complaint about a missing manpage to the
----------------------- schnipp --------------------------------


Background:
===========
Christoph Lameter <christoph@lameter.com> described the problem of the
undocumented(7) symlinks in debian-policy:

> The symlink causes a stupid manpage to show up saying that there is no
> manpage. I would prefer if man would simply say there is no manpage.  
> 
> The fact that there is already a bug filed is evident from the BTS. Why
> put a symlink to undocumented into the package?
> 
> Sometimes I check for documentation by doing a dpkg -L. I see a manpage
> for a certain command and do a "man xxx". Result is a "undocumented"   
> manpage. Very irritating. It would have saved some effort if there simply
> were no manpage.

I hope, that my changes fix this problem and clarify the question
whether a missing man page is considered as a bug.

Ciao

        Roland
---------------------------------------
Received: (at 39830-close) by bugs.debian.org; 18 Nov 2002 03:38:46 +0000
>From troup@auric.debian.org Sun Nov 17 21:38:46 2002
Return-path: <troup@auric.debian.org>
Received: from auric.debian.org [206.246.226.45] (mail)
	by master.debian.org with esmtp (Exim 3.12 1 (Debian))
	id 18DckH-0008Ei-00; Sun, 17 Nov 2002 21:38:45 -0600
Received: from troup by auric.debian.org with local (Exim 3.35 1 (Debian))
	id 18Dcdh-0003Pl-00; Sun, 17 Nov 2002 22:31:57 -0500
From: Manoj Srivastava <srivasta@debian.org>
To: 39830-close@bugs.debian.org
X-Katie: lisa $Revision: 1.19 $
Subject: Bug#39830: fixed in debian-policy 3.5.8.0
Message-Id: <E18Dcdh-0003Pl-00@auric.debian.org>
Sender: James Troup <troup@auric.debian.org>
Date: Sun, 17 Nov 2002 22:31:57 -0500
Delivered-To: 39830-close@bugs.debian.org

We believe that the bug you reported is fixed in the latest version of
debian-policy, which is due to be installed in the Debian FTP archive:

debian-policy_3.5.8.0.dsc
  to pool/main/d/debian-policy/debian-policy_3.5.8.0.dsc
debian-policy_3.5.8.0.tar.gz
  to pool/main/d/debian-policy/debian-policy_3.5.8.0.tar.gz
debian-policy_3.5.8.0_all.deb
  to pool/main/d/debian-policy/debian-policy_3.5.8.0_all.deb



A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 39830@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Manoj Srivastava <srivasta@debian.org> (supplier of updated debian-policy package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Format: 1.7
Date: Fri, 15 Nov 2002 00:36:54 -0600
Source: debian-policy
Binary: debian-policy
Architecture: source all
Version: 3.5.8.0
Distribution: unstable
Urgency: low
Maintainer: Debian Policy List <debian-policy@lists.debian.org>
Changed-By: Manoj Srivastava <srivasta@debian.org>
Description: 
 debian-policy - Debian Policy Manual and related documents
Closes: 39830 53582 65764 72980 120585 160248 160776 162812 164035 167425
Changes: 
 debian-policy (3.5.8.0) unstable; urgency=low
 .
   Manoj
   * Added example for why one may call ldconfig anywhere in the
     postsint.                                                closes: Bug#120585
   * Add the modifications about base system, as opposed to the soon to be
     obsolete base section (I assume it is)                    closes: Bug#53582
   * Rearranged the virtual packages list.                     closes: Bug#72980
   * This is basically an attempt to ratify the current practice of using
     debhelper in the clean target. Currently, policy does not require
     debhelper to be installed when the clean target is run, even though it
     is in the build-depends field. This was a simple oversight.
                                                              closes: Bug#164035
   * No longer depend on fileutils.                           closes: Bug#167425
   * Added the Apps/Science menu section                      closes: Bug#162812
   * Applied text patch from Joey Hess to the debconf spec simply make it
     conform to the reality of how some things work now. This is part of an
     effort to make debconf and cdebconf better substitutes for each
     other. Since it was not an XML patch, no special markup is present in
     the new content, except where I made guesses.            closes: Bug#160776
   * Clarify section 13.3.                                    closes: Bug#160248
   * Removed the undocumented(7) hack requirement.            closes: Bug#39830
   Josip
   * Removed the obsolete notion of documenting changes within the copyright
     file,                                                     closes: Bug#65764
Files: 
 5b686731ba664feef249c5a50ae1d6d7 792 doc optional debian-policy_3.5.8.0.dsc
 aa9531b73ff1d967a2849d1c8ee00939 570469 doc optional debian-policy_3.5.8.0.tar.gz
 8446cfe6721a1e35241ac65ec06bac84 606672 doc optional debian-policy_3.5.8.0_all.deb
 b4eee03d7ea7b1b518b20f0a84bb2b1f 94491 byhand - policy.txt.gz
 bd2b450be68264ec0850690d65c6f013 2150 byhand - menu-policy.txt.gz
 1a228eb86a4c3706e3be2e863d9000f0 1562 byhand - mime-policy.txt.gz
 4d21496f61823907d92cc59ddec8235a 4496 byhand - policy-process.txt.gz
 1436c60eb402c823b2067822cd82eead 4405 byhand - perl-policy.txt.gz
 bcaec31c42155e0df0586e19f40f0af1 105033 byhand - policy.html.tar.gz
 e1a5b6c92d522f1876937d62dc49b69c 2817 byhand - menu-policy.html.tar.gz
 bc777baa3c85c67678303116999868e1 2160 byhand - mime-policy.html.tar.gz
 040c686f9b837f820040692ab0a9b03c 5201 byhand - policy-process.html.tar.gz
 cea97af87e41dbe9b539e0327cf34771 5793 byhand - perl-policy.html.tar.gz
 053d5b191f84c9be24afff4600a0112e 6365 byhand - debconf_specification.txt.gz
 0e259ae8ed1ef48ce9bf27b324199b5b 31357 byhand - debconf_specification.html
 3ed7aa5a489834b24bb28ff377a34aa9 10982 byhand - libc6-migration.txt
 7c6c1d1be799f750ad8085e0d3eecad8 9288 byhand - virtual-package-names-list.txt
 32eb83e427700a4f214213a83d60db78 176749 byhand - policy.ps.gz
 1223e02fc2bc9f9d9372becbf2e75afd 409464 byhand - policy.pdf.gz
 540c14b5604949da1951ab6c00c8c6e1 18083 byhand - upgrading-checklist.txt
 93679f707ec4cbc94b6f667afb1f2600 34997 byhand - fhs-2.1.html.tar.gz
 02153a8048e28d94dd72c0cbcf0c1816 98312 byhand - fhs.txt

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (GNU/Linux)

iD8DBQE91JpdIbrau78kQkwRAmxVAJ0ZWW4dD/hT/+25CP/iaMskQa7AAwCfWZyR
RW5X1IwavY9DSjqgcCpwAdE=
=PKj7
-----END PGP SIGNATURE-----



Reply to: