makedocs.pl should be able to skip regenerating Bugzilla Guide

RESOLVED FIXED in Bugzilla 5.0

Status

()

--
enhancement
RESOLVED FIXED
6 years ago
5 years ago

People

(Reporter: koosha.khajeh, Assigned: gerv)

Tracking

unspecified
Bugzilla 5.0

Details

(Whiteboard: [fixed by blocker])

Attachments

(1 attachment, 1 obsolete attachment)

1.22 KB, patch
LpSolit
: review-
Details | Diff | Splinter Review
(Reporter)

Description

6 years ago
Created attachment 675934 [details] [diff] [review]
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.
Attachment #675934 - Flags: review?(LpSolit)

Comment 1

6 years ago
(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.
(Reporter)

Comment 2

6 years ago
(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.
(Reporter)

Comment 3

6 years ago
Created attachment 676745 [details] [diff] [review]
patch - v1.0
Attachment #675934 - Attachment is obsolete: true
Attachment #676745 - Flags: review?(LpSolit)
Attachment #675934 - Flags: review?(LpSolit)

Comment 4

6 years ago
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).
Attachment #676745 - Flags: review?(LpSolit) → review+

Updated

6 years ago
Flags: approval+
Target Milestone: Bugzilla 4.4 → Bugzilla 5.0

Comment 5

6 years ago
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.
Attachment #676745 - Flags: review+ → review-

Updated

6 years ago
Flags: approval+
(Reporter)

Comment 6

6 years ago
(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

6 years ago
(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.
(Reporter)

Updated

5 years ago
Assignee: koosha.khajeh → documentation
Status: ASSIGNED → NEW
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
Status: NEW → RESOLVED
Last Resolved: 5 years ago
Resolution: --- → INVALID

Comment 9

5 years ago
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.
Assignee: documentation → gerv
Depends on: 961755
Resolution: INVALID → FIXED
Whiteboard: [fixed by blocker]
You need to log in before you can comment on or make changes to this bug.