806181 - makedocs.pl should be able to skip regenerating Bugzilla Guide

Status: RESOLVED FIXED

(Bugzilla :: Documentation, enhancement)

Description

[Koosha KM]

Attachment: patch - v1

When I make some changes to the API doc and I want to regenerate the API doc, I should be able to skip regenerating Bugzilla Guide which is an unnecessary and time-consuming step. This enhancement is highly useful for development purposes.

I'll add a command line option '--skip-bzguide' for this purpose.

Comment 1

[Frédéric Buclin]

(In reply to Koosha Khajeh Moogahi [:koosha] from comment #0)
> I'll add a command line option '--skip-bzguide' for this purpose.

This is a pretty uncommon name. --no-guide is a better name IMO.

Comment 2

[Koosha KM]

(In reply to Frédéric Buclin from comment #1)
> (In reply to Koosha Khajeh Moogahi [:koosha] from comment #0)
> > I'll add a command line option '--skip-bzguide' for this purpose.
> 
> This is a pretty uncommon name. --no-guide is a better name IMO.

Or --without-guide since there is already --with-pdf option.

Comment 3

[Koosha KM]

Attachment: patch - v1.0

Comment 4

[Frédéric Buclin]

Comment on attachment 676745 [details] [diff] [review]
patch - v1.0

>+    unless (grep { $_ eq '--without-guide' } @ARGV) {

Instead of this UNLESS block, I much prefer:

     next if (grep { $_ eq '--without-guide' } @ARGV);


r=LpSolit with this change on checkin (unless you want to upload a new patch with this change in it, which would make my life easier).

Comment 5

[Frédéric Buclin]

Comment on attachment 676745 [details] [diff] [review]
patch - v1.0

Oops! Actually, this is not OK at all. Your patch erases all the existing documentation when we pass --without-guide.

Comment 6

[Koosha KM]

(In reply to Frédéric Buclin from comment #5)
> Comment on attachment 676745 [details] [diff] [review]
> patch - v1.0
> 
> Oops! Actually, this is not OK at all. Your patch erases all the existing
> documentation when we pass --without-guide.

:-))

So, what is your recommendation?

Comment 7

[Frédéric Buclin]

(In reply to Koosha Khajeh Moogahi [:koosha] from comment #6)
> So, what is your recommendation?

What do you mean? It shouldn't erase existing documentation, but simply not recompile them.

Comment 8

[Gervase Markham [:gerv]]

This bug has no meaning in the new world. By default, the build system generates HTML and TXT, and will do a big PDF if you pass --with-pdf.

Gerv

Comment 9

[Frédéric Buclin]

This is not invalid at all. What koosha is asking for is the ability to build the API doc only without also recompiling all the documentation. This is exactly what you did in bug 961755 when you introduced --pod-only to fix doc issues on bugzilla.org.