Bug 105608 - fdc(4) debugging description staled
Summary: fdc(4) debugging description staled
Status: Open
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Eugene Grosbein
URL: https://github.com/freebsd/freebsd-sr...
Keywords: easy
Depends on:
Blocks:
 
Reported: 2006-11-16 16:20 UTC by Eugene Grosbein
Modified: 2023-10-09 11:49 UTC (History)
6 users (show)

See Also:


Attachments
fdc(4) patch (2.38 KB, patch)
2021-09-21 06:03 UTC, Felix Johnson
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Eugene Grosbein 2006-11-16 16:20:05 UTC
	fdc(4) manual page, NOTES and fdcontrol(8) manual page
	describe kernel option FDC_DEBUG that was removed by phk
	2 years ago with the exception of pc98 architecture.
	
	OTOH, the kernel tunnable debug.fdc.debugflags is not documented.
	By the way, I think it should be made loader tunnable also
	to deal with boot-time problems.

Fix: 

Just remove FDC_DEBUG from mentioned manuals and NOTES.
How-To-Repeat: 
	Try to find FDC_DEBUG in modern FreeBSD/i386
Comment 1 commit-hook freebsd_committer freebsd_triage 2017-04-07 16:15:12 UTC
A commit references this bug:

Author: sevan
Date: Fri Apr  7 16:14:26 UTC 2017
New revision: 316615
URL: https://svnweb.freebsd.org/changeset/base/316615

Log:
  Remove the last vestiges of FDC_DEBUG & FD_DEBUG
  FDC_DEBUG is not referenced in any c or header files but traces of it
  still remain in other files.

  PR:		105608
  Reported by:	Eugene Grosbein <ports AT grosbein DOT net>
  Reviewed by:	imp
  Approved by:	bcr (mentor)
  MFC after:	7 days
  Differential Revision:	https://reviews.freebsd.org/D10303

Changes:
  head/share/man/man4/fdc.4
  head/sys/conf/NOTES
  head/sys/conf/options
  head/sys/modules/fdc/Makefile
  head/sys/sparc64/conf/NOTES
  head/usr.sbin/fdcontrol/fdcontrol.8
Comment 2 Sevan Janiyan freebsd_committer freebsd_triage 2017-04-07 16:23:53 UTC
Removed FDC_DEBUG & FD_DEBUG, now to look into debug.fdc.debugflags.
Comment 3 commit-hook freebsd_committer freebsd_triage 2018-09-09 18:09:33 UTC
A commit references this bug:

Author: eugen
Date: Sun Sep  9 18:08:40 UTC 2018
New revision: 338544
URL: https://svnweb.freebsd.org/changeset/base/338544

Log:
  MFC r316615 by sevan: Remove the last vestiges of FDC_DEBUG & FD_DEBUG

  PR:			105608
  Differential Revision:	https://reviews.freebsd.org/D10303

Changes:
_U  stable/11/
  stable/11/share/man/man4/fdc.4
  stable/11/sys/conf/NOTES
  stable/11/sys/conf/options
  stable/11/sys/modules/fdc/Makefile
  stable/11/sys/sparc64/conf/NOTES
  stable/11/usr.sbin/fdcontrol/fdcontrol.8
Comment 4 commit-hook freebsd_committer freebsd_triage 2018-09-09 18:11:37 UTC
A commit references this bug:

Author: eugen
Date: Sun Sep  9 18:10:36 UTC 2018
New revision: 338545
URL: https://svnweb.freebsd.org/changeset/base/338545

Log:
  MFC r316615 by sevan: Remove the last vestiges of FDC_DEBUG & FD_DEBUG

  PR:             105608
  Submitted by:   Differential Revision:  https://reviews.freebsd.org/D10303

Changes:
_U  stable/10/
  stable/10/share/man/man4/fdc.4
  stable/10/sys/conf/NOTES
  stable/10/sys/conf/options
  stable/10/sys/modules/fdc/Makefile
  stable/10/sys/sparc64/conf/NOTES
  stable/10/usr.sbin/fdcontrol/fdcontrol.8
Comment 5 Eugene Grosbein freebsd_committer freebsd_triage 2018-09-09 18:45:22 UTC
The case is not closed as r316615 was incomplete: it failed to remove reference to opt_fdc.h from sys/dev/fdc/fdc.c and sys/modules/fdc/Makefile, so it broke build and was partially reverted.
Comment 6 Felix Johnson 2021-09-21 06:03:10 UTC
Created attachment 228081 [details]
fdc(4) patch

Document fdc(4) sysctls, including debug.fdc.debugflags.
Comment 7 Felix Johnson 2021-09-21 06:05:19 UTC
The failed MFC was for FreeBSD 10. FDC_DEBUG is not mentioned in fdc(4) in FreeBSD 13. I think this can be closed once the patch is applied.
Comment 8 Benedict Reuschling freebsd_committer freebsd_triage 2023-10-06 09:39:04 UTC
Remove Sevan as assignee as his commit bit expired. Give this PR a chance to be taken by someone else.
Comment 9 Graham Perrin 2023-10-07 03:55:35 UTC
^Triage: 

* remove a deprecated keyword
* reduce the priority, to the norm for a report of this type
* status (typically not in progress, where the assignee is not a person).
Comment 10 Graham Perrin 2023-10-07 04:07:06 UTC
Comment on attachment 228081 [details]
fdc(4) patch

Sorry, this patch from September 2021 is no longer applicable; please see below. 

Re: the sole change since that time (<https://github.com/freebsd/freebsd-src/commits/main/share/man/man4/fdc.4>), keyword 'easy' does still apply. 

Re: <https://github.com/freebsd/freebsd-src/blob/main/CONTRIBUTING.md>, an applicable patch might be a candidate for a simple pull request. 


% git -C /usr/src apply --check --verbose /tmp/228081.patch 
Checking patch share/man/man4/fdc.4...
error: while searching for:
.\"
.\" $FreeBSD$
.\"
.Dd April 7, 2017
.Dt FDC 4
.Os
.Sh NAME

error: patch failed: share/man/man4/fdc.4:27
error: share/man/man4/fdc.4: patch does not apply
%
Comment 11 Eugene Grosbein freebsd_committer freebsd_triage 2023-10-09 08:53:00 UTC
My PR. Take this long forgotten one.
Comment 12 commit-hook freebsd_committer freebsd_triage 2023-10-09 11:49:50 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=3523f0677ef514fe72710033c73cc58517b9cda8

commit 3523f0677ef514fe72710033c73cc58517b9cda8
Author:     Felix Johnson <felix.the.red@gmail.com>
AuthorDate: 2023-10-09 11:46:03 +0000
Commit:     Eugene Grosbein <eugen@FreeBSD.org>
CommitDate: 2023-10-09 11:48:52 +0000

    fdc.4: document fdc sysctls

    PR:             105608
    MFC-after:      1 week

 share/man/man4/fdc.4 | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 56 insertions(+), 1 deletion(-)