Novell Home

Lfl/Lessons for Lizards Quick Start

From Developer Community

< Back to Lessons for Lizards Home

Contents

[edit]

Building the Lessons for Lizards Book

[edit]

Getting and Installing the Software

  1. [edit]

    Adding the susedoc Repository to Your Installation Sources

    • Run YaST -> Software -> Installation Source
    • Choose Add -> HTTP
    • Enter the following data:
      Server Name: software.opensuse.org
      Directory on Server: download/home:/thomas-schraitle/<REPOSITORY>
      replacing <REPOSITORY> with one of the following:
      Product Repository
      openSUSE Factory openSUSE_Factory
      openSUSE 10.3 openSUSE_10.3
      openSUSE 10.2 openSUSE_10.2
      SuSE Linux 10.1 Java_Sun-Java-1.5_SUSE_Linux_10.1
      SUSE Linux 10.0 Java_Sun-Java-1.5_SUSE_Linux_10.0
    • Confirm with Next and Accept to import the GPG key, if applicable
    • A new YUM repository should have been added to the software catalog list
    • Confirm with Finish
  2. [edit]

    Checking the FOP Version

    • Run YaST -> Software -> Software Management.
    • Enter the term fop in the search box.
      If you do not see a search box, first choose Filter ->Search.
    • If fop is not installed, no action is required--proceed with the next step
    • If fop is installed, mark the fop entry, right-click the box in front of fop, and choose Update from the drop-down menu. After doing that, select the Version tab in the bottom right part of the Software Management window and select the version number 0.93 (or higher).
  3. [edit]

    Checking the Java Version

    • Run YaST -> Software -> Software Management.
    • Enter the term java-1_5 in the search box.
      If you do not see a search box, first choose Filter ->Search.
    • If java-1_5_x-sun (with x being a placeholder) is installed, no action is required. Proceed with the next step.
    • If java-1_5_x-sun (with x being a placeholder) is not installed, mark it for installation.
    • If the search does not produce any results, you need to add the non-OSS installation repository for your openSUSE or SUSE Linux version. Proceed as described in #Adding the susedoc Repository to Your Installation Sources with the following data:
      Server Name: download.opensuse.org
      Directory on Server: <REPOSITORY>
      replacing <REPOSITORY> with one of the following:
      Product Repository
      openSUSE Factory distribution/SL-Factory-non-oss/inst-source-extra
      openSUSE 10.2 distribution/10.2/repo/non-oss
      SuSE Linux 10.1 distribution/SL-10.1/non-oss-inst-source
      SUSE Linux 10.0 distribution/SL-10.0-OSS/inst-source-java
  4. [edit]

    Installing the susedoc Package

    • Run YaST -> Software -> Software Management.
    • Enter the term susedoc in the search box.
      If you do not see a search box, first choose Filter ->Search.
    • Mark the package susedoc for installation and confirm with Accept.
    • A screen probably then appears, listing additional packages that need to be installed to resolve dependencies. Confirm with Continue.
    • Select not to install more packages by choosing No in the pop-up that appears.
  5. [edit]

    Updating the susedoc Package

    From time to time there are improvements of the susedoc RPM package. Update the package with your favorite tool (YaST, smart, rug, ...)


[edit]

Checking Out the LfL Subversion Repository

  • Make sure that the package subversion is installed by running the command 
    rpm -q subversion
  • Change into the directory that should host the LfL project files, for example: 
    cd ~
  • Check out the SVN repository. The project files are copied to a folder named LfL 
    svn checkout https://forgesvn1.novell.com/svn/lfl/trunk LfL
[edit]

Building the Book

  • Change into the working directory of the LfL project: 
    cd LfL/books/en
  • Source the LfL environment file: 
    . ENV-lessons4lizards
  • Build the book with one of the following commands: 
    make pdf
    		 generates a black and white PDF (Lessons4Lizards.pdf) 
    make color-pdf
    		 generates a color PDF (Lessons4Lizards-online.pdf) 
    make html
    		 generates HTML files (html/Lessons4Lizards/index.html)



[edit]

Uploading Contributions

[edit]

Prerequisites

To be able to participate in the Lessons for Lizards project, an openSUSE login is required and you need to become a member of the project itself. Membership is needed to be able to commit files to SVN. The login is used to authenticate with the SVN server.

  • [edit]

    Getting an openSUSE Account

    • If you do not already have an openSUSE and Novell account, go to http://en.opensuse.org/ and click Create an account or log in.
    • Click Create New Account and follow the instructions on the screen.
  • [edit]

    Becoming an LfL Project Member

    • Adding a new member to the project requires manual interaction from one of the project administrators. Please contact lessons4lizards@suse.de and ask to be added to the project. Include your openSUSE and Novell login name in your request—it is needed to register you. Please give us at least one work day to fill your request.
[edit]

Checking the Status of Your Local Files

  • Change into your LfL working directory: 
    cd ~/LfL/books/en
  • Issue the following command: 
    svn status
  • Files you have modified are listed and preceded with M.
[edit]

Validating Your Files

  • Always validate your files with the command 
    make validate

    from the books/LANGUAGE directory before committing your changes. If you run this command from the xml subdirectory, you get a no target error. Committing invalid files would result in a book that does not build anymore.

[edit]

Commiting Your Changes

  • Issue the following command: 
    svn commit --username "<USERNAME>" --message "<MESSAGE>" <FILE(s)>
    <USERNAME>: Your openSUSE login name.
    <MESSAGE>: Your commit message that lists the changes you have made. Never commit files without an explanatory commit message!
    <FILE(s)> Optional parameter. Specify the file or files to submit, separated by spaces. If you do not specify this parameter, all your modified files will be submitted with the same commit message.
  • Before the files are sent to the SVN server, you are prompted for a password. Enter the password of your openSUSE account.


[edit]

Useful SVN commands

[edit]

Adding New Files

  • Files that only exist locally but not on the SVN server, need to be added before being committed to the server: 
    svn add <FILE(s)>
[edit]

Viewing log Messages

  • Whenever a file is committed to the SVN server, one is supposed to enter a log message describing the changes having been made. To view all log messages for a certain file type: 
    svn log <FILE>
[edit]

Getting File Information

  • In order to retrieve information (such as Last Changed Date) on a file, issue the following command: 
    svn info <FILE>
[edit]

Comparing Versions

  • To compare the local working copy against the version on the SVN server, type: 
    svn diff <FILE>
  • To compare an old revision against the local working copy, type: 
    svn diff -r<REVISION NUMBER> <FILE>
  • To compare two arbitrary revisions of a file, type; 
    svn diff -r<REVISION NUMBER 1>:<REVISION NUMBER 2> <FILE>
Retrieved from "http://developer.novell.com/wiki/index.php/Lfl/Lessons_for_Lizards_Quick_Start"

Novell® Making IT Work As One™

© 2009 Novell, Inc. All Rights Reserved.