1 Tutorial

• Find the location of an overlay repository that You want to generate an eclass documentation from.

  The tool portageq can help in finding paths of installed repositories. Execute it with arguments: ‹get_repo_path›, ‹/› and ‹name-of-the-installed-repository›

  In this example we will use the main ::gentoo repository:

    portageq get_repo_path / gentoo

• Check if your eclass is in the selected repository.

    ls -1 "$(portageq get_repo_path / gentoo)"/eclass/*.eclass

• Give the path to an eclass to eclass2scrbl.

  In this example we will use the "toolchain-funcs" eclass:

    eclass2scrbl "$(portageq get_repo_path / gentoo)"/eclass/toolchain-funcs.eclass

• Eclass2Scrbl should have generated a "eclass-name.scrbl" (so, file "toolchain-funcs.scrbl" from the last example). Using that scribble file You can now generate any of documentation formats supported by Scribble.

  In this example we will generate a Markdown document:

    scribble --markdown --quiet toolchain-funcs.scrbl