Hi Ethan,

Your last message of things that need adding to the build instructions actually reads like the contents page of section 10 of the manual. Some sections of the manual are a little muddled. I've reworked some stuff a couple of times to try to improve that, and certainly some things could still be better organised. However, the build instructions are pretty clear, and are only split between two pages in the HTML built from the docbook. One is the shopping list, and the other describes what to do with all the pieces. I hardly think that represents docbook terribly fragmenting things. If two pages drives you nuts, I don't think there is a lot we can do to help. :-) The only part of the shopping list section which is not in a nice list is the basic GNU packages. I'll change that, as it would be clearer. Checking out the stuff from mspgcc at Sourceforge is shown as actual commands, and the tools you need to have installed is already a bullet pointed list.

Any reports of errors, omissions and out of date items are gratefully received. However, try to complain about the bits that have genuine problems. So far you have mostly complained that it should look like it already does. :-)

Regards,
Steve


Ethan Gold wrote:

Steve,

First, let me say that this is a huge development effort,
and I applaud the efforts of everyone involved.
I don't want to seem ungrateful for all the exceptional
work that has gone into this project.

Yes, the manual contains most of the information needed,
but the format is not conducive to getting everything set up.
I knew for format looked familiar, and now see the "every
section a page unto itself"  structure that docbook delivers
(drove me *nuts* when I used it for a large project of my own).

The consolidation that I think is required, is placing all the
necessary items on a single page as a bulleted list so you
can go shopping for all your parts at once, picking what
you need for each platform you're building for.
Perhaps it could be organized by windows vs. unix, and then
sections under the unix heading for parts that only go with
certain OS's.

I'll post my "this is what I did" doc in a separate message
momentarily. I'm cleaning it up as we type (you'll say "THAT'S cleaned up?").
It's sort of a quick-start guide for getting the whole toolchain built.

    -E


On Feb 26, 2004, at 10:12 AM, Steve Underwood wrote:

Ethan Gold wrote:

Hi Matthew,

I think the problem with the manual is not so much in its content,
but its organization. I found may way through using the manual,
but it could use some structure. This is particularly true regarding
the web pages which discuss the various JTAG communication
tools. A Linked list of package names with brief descriptions (and
available longer descriptions) instead of paragraphs interspersed
with "this is available _here_" will make finding the tools much simpler.

here are my brief suggestions, and I'll post my own notes today,
after which everyone can tear them apart and make fun of my
inefficiency.

1) All required packages should be listed together on one page
along with the latest version numbers that work together


The first part of the building section in the manual is a shopping list of the things you need, including versions.

1.5) A consolidated list of where each package is available (CVS, FTP, etc.)


That is there too.

2) recommended configure options to make everything end up
in reasonable places (since various packages require different options)


That is there too.

3) known building quirks


I'm not sure what you expect here.

4) A dependancy list/build order


Yep, just follow the instructions in the manual.

5) A consolidated summary of which capabilities each package provides.


Now that is a valid point. For example, you need libc to do assembly language program,ing because libc contains all the headers files used for both C and assembly language. That isn't obvious, and I don't think it is documented right now.

Regards,
Steve



-------------------------------------------------------
SF.Net is sponsored by: Speed Start Your Linux Apps Now.
Build and deploy apps & Web services for Linux with
a free DVD software kit from IBM. Click Now!
http://ads.osdn.com/?ad_id=1356&alloc_id=3438&op=click
_______________________________________________
Mspgcc-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/mspgcc-users




-------------------------------------------------------
SF.Net is sponsored by: Speed Start Your Linux Apps Now.
Build and deploy apps & Web services for Linux with
a free DVD software kit from IBM. Click Now!
http://ads.osdn.com/?ad_id=1356&alloc_id=3438&op=click
_______________________________________________
Mspgcc-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/mspgcc-users



Reply via email to