Bug 234992 - shells/bash: Bash man not mandoc-ed - requires groff(1)
Summary: shells/bash: Bash man not mandoc-ed - requires groff(1)
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Emanuel Haupt
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2019-01-16 08:52 UTC by Athan Papadimitriou
Modified: 2019-01-16 16:20 UTC (History)
1 user (show)

See Also:
bugzilla: maintainer-feedback? (ehaupt)


Attachments
/tmp/bash_manpage_fix.patch (2.11 KB, patch)
2019-01-16 15:14 UTC, Emanuel Haupt
no flags Details | Diff
man page fix (1.74 KB, patch)
2019-01-16 15:19 UTC, Emanuel Haupt
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Athan Papadimitriou 2019-01-16 08:52:37 UTC
Viewing "man bash" is asking for groff(1).
Obviously the man source (bash.1) has not been processed with "mandoc -T man". Doing that manually on a gunzipped copy corrects the problem.

Athan
Comment 1 commit-hook freebsd_committer 2019-01-16 14:00:31 UTC
A commit references this bug:

Author: ehaupt
Date: Wed Jan 16 13:59:31 UTC 2019
New revision: 490481
URL: https://svnweb.freebsd.org/changeset/ports/490481

Log:
  Mandoc'ify man pages to avoid dependency to groff.

  PR:		234992 (based on)
  Submitted by:	sakisp@gmail.com

Changes:
  head/shells/bash/Makefile
Comment 2 Emanuel Haupt freebsd_committer 2019-01-16 14:01:52 UTC
Good catch! Thanks a lot. I've just committed an update.
Comment 3 Baptiste Daroussin freebsd_committer 2019-01-16 14:52:10 UTC
This is wrong and it badly format the manpage.

2 things are wrong here, mandoc -T man does nothing any better that what the man command would do (except the man command check for unsupported things before trying to render with mandoc)

mandoc -Tlint -Wunsupp would show you the issue.

Now with what has just be committed, look at the manpage for exemple the --no-profile /etc/profile is duplicated for example (there are other issues like that)

Now if you want to fix properly, just run manually mandoc -Tlint -Wunsupp you will see some caracters in the comment sections are not supported, juste remove them and you won't need groff anymore.

Only the bash.1 has issues, not bashbug.1  btw
Comment 4 Emanuel Haupt freebsd_committer 2019-01-16 15:14:00 UTC
Created attachment 201188 [details]
/tmp/bash_manpage_fix.patch

Oh shoot! Thanks for pointing it out. What do you think about this patch.
Comment 5 Emanuel Haupt freebsd_committer 2019-01-16 15:19:57 UTC
Created attachment 201189 [details]
man page fix
Comment 6 Baptiste Daroussin freebsd_committer 2019-01-16 16:11:54 UTC
looks better, actually the diff view in here cannot render the unsupported characters, but I bet you removed them (there was 4, 2 per line) and tested :) so go ahead
Comment 7 commit-hook freebsd_committer 2019-01-16 16:14:17 UTC
A commit references this bug:

Author: ehaupt
Date: Wed Jan 16 16:14:06 UTC 2019
New revision: 490489
URL: https://svnweb.freebsd.org/changeset/ports/490489

Log:
  Properly fix broken man pages by removing unsupported characters.

  PR:		234992 (based on)
  Reviewed by:	bapt
  Reported by:	bapt

Changes:
  head/shells/bash/Makefile
  head/shells/bash/files/patch-doc_bash.1