[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Gnu-arch-users] Re: documentation as info

From: Tom Lord
Subject: Re: [Gnu-arch-users] Re: documentation as info
Date: Tue, 16 Sep 2003 14:44:39 -0700 (PDT)

    > From: Zack Brown <address@hidden>

    > On Tue, Sep 16, 2003 at 12:41:53PM -0700, Tom Lord wrote:
    > > But it really wouldn't be difficult for you to to make a docs-tla
    > > branch and merge those changes yourself.  Compile up a copy of systas
    > > and `make html ps' in the appropriate directory.   If you did that
    > > work, I could certainly merge back from your branch.

    > Sounds good. I'd like to do that. Would you help me figure out your
    > documentation format and the procedures for compiling the pages, and would
    > you agree to apply acceptable patches within a couple days of when I send
    > them to you?

First of all, I've now caught up on the bug db issues (both of them)
that had tutorial patches.  They were fairly minor (quite welcome and,
thanks to jgoerzen -- but they weren't the big massive revisions you
seem to have implied in your original flame).

Two tutorial issues remain open that don't include patches.  Both will
be corrected when I do a front-to-back read-through/walk-through,
updating stuff.  _That_ is the big task that remains for the tutorial:
it's time consuming; I'm not holding my breath in expectation of
finding a volunteer qualified to take that off my hands; it makes
pretty good sense to have deferred that while CLI changes settle out a
bit; and it has nothing to do with patches that sat in the queue for a
whopping 8 days.  So, uh.... "Back off man, I'm a scientist." :-)

As for building/editting docs.    Make sure you are up-to-date in your
mirror of my archive if you have one.   Build the configs/
config.  In the build dir for src/docs-tla/src, `make html ps'.

The format is simple, mostly pretty wiki-ish, and easy to infer by
looking at the source in parallel with the html.   A number of
contributors have had no problem taking that approach.   If you
encounter a specific question, I'm happy to answer it.

You will encounter a problem building the docs if you have the
second-most-recent change to hackerlab and not the most recent.   So,
be sure you are up-to-date.


(And, no, the on-line copy at hasn't been updated yet
because FSF CVS is down at the moment.)

reply via email to

[Prev in Thread] Current Thread [Next in Thread]