Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 1 Apr 1998 17:06:57 +0100
From:      nik@iii.co.uk
To:        Jun Kuriyama <kuriyama@opt.phys.waseda.ac.jp>
Cc:        freebsd-doc@FreeBSD.ORG, committers@FreeBSD.ORG, nik@FreeBSD.ORG
Subject:   Re: Move handbook to doc/en/handbook as part of DTD migration?
Message-ID:  <19980401170657.14561@iii.co.uk>
In-Reply-To: <35225540.E84C3272@opt.phys.waseda.ac.jp>; from Jun Kuriyama on Wed, Apr 01, 1998 at 11:54:56PM %2B0900
References:  <19980330183652.07840@iii.co.uk> <3520D677.7DF34125@opt.phys.waseda.ac.jp> <19980331155059.24295@iii.co.uk> <35225540.E84C3272@opt.phys.waseda.ac.jp>

next in thread | previous in thread | raw e-mail | index | archive | help
On Wed, Apr 01, 1998 at 11:54:56PM +0900, Jun Kuriyama wrote:
> > Of course, if I did this then I may as well remove the branch.
> 
>   Hmmm.  Will you use branch?  Or put Handbook which is converted to
> DocBook into /doc/en/handbook/ ?

This is my plan:

  - At 1830 BST (or thereabouts), I'll tag doc/handbook/ with 2 tags.
    LINUXDOC_2_DOCBOOK_START and LINUXDOC_2_DOCBOOK. These will be regular 
    tags, *not* branch tags.

  - I will then start converting the handbook, as outlined in 
    http://www.nothing-going-on.demon.co.uk/FreeBSD/docbook-migration.html
    (sections 6 and onwards). The converted handbook will be placed in
    doc/en/handbook/.

  - As I convert the handbook (and this will probably take several evenings)
    I'll commit each change group. In addition, I'll update the README file 
    in doc/en/handbook/ to explain (in detail) how I made the change, so 
    that the Japanese team can follow as and when they want to.

    Most of those changes will be markup changes. However, I'll try and 
    keep the DocBook version in sync with any changes that happen to 
    doc/handbook by periodically looking at the result of

        % cvs diff -u -r LINUXDOC_2_DOCBOOK 

    in doc/handbook, and updating the position of the LINUXDOC_2_DOCBOOK
    tag after I've merged in the changes. The merge will have to be done 
    by hand (without CVS assistance) since the filenames are unlikely to
    be the same, and the markup changes will almost certainly be too 
    different for CVS to comfortably handle.

I think the Japanese team should do the following:

  - Wait until I've put down the LINUXDOC_2_DOCBOOK_START tag.

  - Merge in any changes to the files in doc/handbook/ that have not been
    merged into doc/ja/handbook/, up to and including the file versions
    that match the LINUXDOC_2_DOCBOOK_START tag.

  - Then, lay down your own tags. Since you'll (presumably) be doing this
    in the same directory, you'll want to branch the tree. I suggest 
    something like

        % cvs checkout doc/ja/handbook
        % cd doc/ja/handbook
        % cvs tag LINUXDOC_2_DOCBOOK_BP
  
    first. The file versions of the LINUXDOC_2_DOCBOOK_BP tagged files 
    should match (or be equivalent to) the versions of the files on the
    English side tagged with LINUXDOC_2_DOCBOOK_START.

    Then branch the tree

        % cvs rtag -b -r LINUXDOC_2_DOCBOOK_BP LINUXDOC_2_DOCBOOK \
            doc/ja/handbook

    This was what I had planned to do, but I don't need to because I'll
    be doing the conversion in a different directory.

  - At this point you can wait for me to finish the conversion and then 
    sync up, or you can match my commits as I make them. That's entirely
    up to you.

    Eventually, you will have a new set of files on the LINUXDOC_2_DOCBOOK
    branch that can completely replace the files on the HEAD. Once you
    do this merge, doc/en/handbook and doc/ja/handbook should be marked up
    in the same way, and doc/handbook can bite the dust (once the problems
    involving the conversion to other formats have been ironed out).

OK?

N
-- 
Work: nik@iii.co.uk                       | FreeBSD + Perl + Apache
Rest: nik@nothing-going-on.demon.co.uk    | Remind me again why we need
Play: nik@freebsd.org                     | Microsoft?

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19980401170657.14561>