Project

General

Profile

Bug #5603

Break dependency on docbook in libshell & SUNWcs

Added by Dan McDonald over 5 years ago. Updated over 5 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
cmd - userland programs
Start date:
2015-02-09
Due date:
% Done:

100%

Estimated time:
Difficulty:
Bite-size
Tags:
needs-triage
Gerrit CR:

Description

The aforementioned file breaks builds on distros without docbook. It's a mere two-line removal, one from each of two files:

--- old/usr/src/lib/libshell/Makefile.doc    Fri Oct 24 01:19:43 2014
+++ new/usr/src/lib/libshell/Makefile.doc    Fri Oct 24 01:19:43 2014
@@ -34,7 +34,6 @@
     COMPATIBILITY \\
     OBSOLETE \\
     shell_styleguide.docbook \\
-    shell_styleguide.html \\
     images/tag_bourne.png \\
     images/tag_i18n.png \\
     images/tag_ksh88.png \\
--- old/usr/src/pkg/manifests/SUNWcs.mf    Fri Oct 24 01:19:43 2014
+++ new/usr/src/pkg/manifests/SUNWcs.mf    Fri Oct 24 01:19:43 2014
@@ -1446,7 +1446,6 @@
 file path=usr/share/doc/ksh/images/tag_l10n.png
 file path=usr/share/doc/ksh/images/tag_perf.png
 file path=usr/share/doc/ksh/shell_styleguide.docbook
-file path=usr/share/doc/ksh/shell_styleguide.html
 file path=usr/share/lib/mailx/mailx.help
 file path=usr/share/lib/mailx/mailx.help.~
 file path=usr/share/lib/tabset/3101

History

#1

Updated by Andrew Stormont over 5 years ago

If you don't have docbook is there any value in installing any of those files? shell_styleguide.docbook in particular looks like it's just cruft in that case.

To disable building of libshell documentation entirely you can drop the Makefile.doc include from the end of libshell Makefile (this one https://github.com/illumos/illumos-gate/blob/master/usr/src/lib/libshell/Makefile#L67)

Perhaps this could be hidden behind an ENABLE_DOCBOOK variable to make it conditional.

$(ENABLE_DOCBOOK)include Makefile.doc
#2

Updated by Josef Sipek over 5 years ago

I think there's a subtle distinction between illumos doesn't have docbook vs. illumos doesn't ship anything that requires docbook. I don't know if people find the style guide useful, but continuing to ship the .docbook file allows distros to generate the html themselves.

I view this change as the first of many that will make SUNWcs go away.

#3

Updated by Andrew Stormont over 5 years ago

It might make sense to update the title to something like "Break dependency on docbook" because I think that's what's really happening here. And I stand by what I said earlier. Why ship the docbook file if you don't have docbook? I think it's highly unlikely that anybody would want to use that file to generate documentation after illumos has been build.

#4

Updated by Dan McDonald over 5 years ago

  • Subject changed from Break dependency on shell_styleguide.html to Break dependency on docbook in libshell & SUNWcs
#5

Updated by Electric Monk over 5 years ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100

git commit 1297d8898193fe6153c0d9a04833671e9d7068f4

commit  1297d8898193fe6153c0d9a04833671e9d7068f4
Author: Dan McDonald <danmcd@omniti.com>
Date:   2015-04-14T13:50:37.000Z

    5603 Break dependency on docbook in libshell & SUNWcs
    Reviewed by: Igor Kozhukhov <ikozhukhov@gmail.com>
    Reviewed by: Hans Rosenfeld <hans.rosenfeld@nexenta.com>
    Reviewed by: Garrett D'Amore <garrett@damore.org>
    Approved by: Gordon Ross <gordon.ross@nexenta.com>

Also available in: Atom PDF