After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 326058 - Refactored man page code
Refactored man page code
Status: RESOLVED FIXED
Product: yelp
Classification: Applications
Component: Man Pages
2.13.x
Other Linux
: Normal normal
: ---
Assigned To: Brent Smith (smitten)
Yelp maintainers
Depends on:
Blocks: 163404 303122 321146 321620 321627 324750
 
 
Reported: 2006-01-07 04:59 UTC by Brent Smith (smitten)
Modified: 2009-09-22 01:48 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
refactored man page code (55.49 KB, patch)
2006-01-07 05:00 UTC, Brent Smith (smitten) 		reviewed Details | Review
updated, with support for BSD's mdoc (65.42 KB, patch)
2006-01-09 04:11 UTC, Brent Smith (smitten) 		committed Details | Review

Description Brent Smith (smitten) 2006-01-07 04:59:35 UTC 
I'm attaching a work in progress patch for man page support.  Much of the code has been refactored and numerous issues have been fixed.

I am posting here to get some feedback about any issues still left with the patch.  Probably still quite a few, but I don't think it's any worse than what's in HEAD at the moment.
Comment 1 Brent Smith (smitten) 2006-01-07 05:00:47 UTC 
Created attachment 56905 [details] [review]
refactored man page code

Please provide feedback.
Comment 2 Don Scorgie 2006-01-07 19:55:04 UTC 
Seems good.  The issues in bugs #324750 #321627 #321620 seem fixed.  Bug #321146 seems somewhat better than previous output.

The mplayer man page (bug #303122) still spews some warning to the console:
Unmatched element: sp
Unmatched element: Count
A bunch of times.

Looks good though, seems to fix most of the man page issues I have experienced.  I vote for commit.
Comment 3 Brent Smith (smitten) 2006-01-07 20:51:51 UTC 
I want to work a little more on BSD man page macros before committing this.
Comment 4 Brent Smith (smitten) 2006-01-09 04:11:40 UTC 
Created attachment 57000 [details] [review]
updated, with support for BSD's mdoc

if you want to see the different between this and the last patch, check out the telnet.1 man page before and after.

Still needs work, but it's a hell of a lot better than it was.
Comment 5 Brent Smith (smitten) 2006-01-09 05:03:00 UTC 
committed to HEAD with two small changes to ignore Count and sp elements in the
man output for the time being.

2006-01-08  Brent Smith  <gnome@nextreality.net>

        * src/yelp-man-parser.c: (yelp_man_parser_parse_file),
        (yelp_man_parser_free), (parser_parse_line), (args_concat_all),
        (macro_ignore_handler), (macro_bold_small_italic_handler),
        (macro_roman_bold_small_italic_handler),
        (macro_new_paragraph_handler), (macro_insert_self_handler),
        (macro_title_header_handler), (macro_section_header_handler),
        (macro_spacing_handler), (macro_define_handler),
        (macro_tp_handler), (macro_ip_handler),
        (macro_hanging_paragraph_handler), (macro_mandoc_handler),
        (macro_url_handler), (macro_rs_re_handler),
        (macro_mandoc_list_handler), (macro_verbatim_handler),
        (is_mandoc_manual_macro_parsed), (is_mandoc_manual_macro_callable),
        (macro_mandoc_utility_handler), (macro_mandoc_listitem_handler),
        (macro_template_handler), (parser_handle_linetag),
        (parser_read_until), (parser_escape_tags),
        (parser_append_given_text_handle_escapes), (parser_append_node),
        (parser_append_node_attr), (parser_parse_table):
        * stylesheets/man2html.xsl:
        man page parser rework, fixes #163404, #321620, #321627, #324750,
        #326058
Comment 6 Brent Smith (smitten) 2006-01-10 00:25:39 UTC 
committed to HEAD with two small changes to ignore Count and sp elements in the
man output for the time being.

2006-01-08  Brent Smith  <gnome@nextreality.net>

        * src/yelp-man-parser.c: (yelp_man_parser_parse_file),
        (yelp_man_parser_free), (parser_parse_line), (args_concat_all),
        (macro_ignore_handler), (macro_bold_small_italic_handler),
        (macro_roman_bold_small_italic_handler),
        (macro_new_paragraph_handler), (macro_insert_self_handler),
        (macro_title_header_handler), (macro_section_header_handler),
        (macro_spacing_handler), (macro_define_handler),
        (macro_tp_handler), (macro_ip_handler),
        (macro_hanging_paragraph_handler), (macro_mandoc_handler),
        (macro_url_handler), (macro_rs_re_handler),
        (macro_mandoc_list_handler), (macro_verbatim_handler),
        (is_mandoc_manual_macro_parsed), (is_mandoc_manual_macro_callable),
        (macro_mandoc_utility_handler), (macro_mandoc_listitem_handler),
        (macro_template_handler), (parser_handle_linetag),
        (parser_read_until), (parser_escape_tags),
        (parser_append_given_text_handle_escapes), (parser_append_node),
        (parser_append_node_attr), (parser_parse_table):
        * stylesheets/man2html.xsl:
        man page parser rework, fixes #163404, #321620, #321627, #324750,
        #326058