On 03/25/2017 09:35 PM, Pierre Labastie wrote:


On 25/03/2017 20:22, Michael D. L. wrote:


On 03/25/2017 10:58 AM, Pierre Labastie wrote:
Hi,
I'd like to know what the followers of this list think about jhalfs documentation, and what would be their advises for improving it. Personally, I have not much idea of how documentation should be done, and apart from text improvement (there is room for that), I am happy with the "README" format (supplemented by help in menus). But some of you may have more clever ideas. So please speak up.

Regards
Pierre
Hi Pierre,

When I started (or tried starting) using jhalfs, I didn't find the current Documentation helpful in any way.

Lot's of technical description of HOW it worked, but not how to USE it.

Only because I like to try/test/experiment I managed to make jhalfs automate my LFS build.

A "How to use" section, with simple examples, and various build-version/types/variation would be very useful.

Make it easy to start using so you don't have to guess about what to enter.

Hi Michael,

Thanks for the answer. I understand it is hard for newcomers to use the tool by looking at the documentation only. It seems the main problem is that it is hardly (or nowhere) said what should be done _before_ running "make". I'll try to add a few sentences to the README file (there does not need to be many, I think).

But do you see other areas where some help is needed? Maybe a "tutorial" about which options to select for a first build?

Or just have the default options "work" provided the right directory has been created with the right mode and owner...

Regards
Pierre
Hi Pierre,

A brief description/example on how to select a book, and choose version would suffice, eg.:

BOOK Settings --->
    Use BOOK (Linux From Scratch System V)
    Release --->
        (SVN) - For using the latest Development Version
(Branch or stable book) - For using a specific Branch or Stable Version
    Branch (branch or stable Version)
        (branch-7.2) Don't know how to use Branches :)
        (8.0) For using the LFS 8.0 Stable Version


BOOK Settings --->
    Use BOOK (Cross-Compiled Linux From Scratch)
    Release --->
        (GIT) - For using the latest Development Version
(Branch or stable book) - For using a specific Branch or Stable Version
    Branch (branch or stable Version)
        (branch-7.2) Don't know how to use Branches :)
(3.0.0-systemd) For using the CLFS 3.0.0 Stable Version with SystemD


General Settings --->
[*] Retrieve source files (Make jhalfs Download the relevant Source Files)
    [*] Run the makefiles (Make jhalfs compile the source files)


As I noted above, I'm not familiar with how the Branches works, or where to find them :)

I tried building CLFS once, found it a bit tricky to figure out the naming convention - IIRC 3.0.0-systemd / 3.0.0-sysvinint is used.

Using GIT with CLFS doesn't give you an option to choose between systemd/sysvinint - is that intentional?

Perhaps you could enable "Retrieve Source Files" and "Run makefiles" by default.

Best regards
 Michael





--
http://lists.linuxfromscratch.org/listinfo/alfs-discuss
FAQ: http://www.linuxfromscratch.org/faq/
Unsubscribe: See the above information page

Reply via email to