From 2a395005b50580870058edadc587dbc383c32cff Mon Sep 17 00:00:00 2001 From: moodler Date: Fri, 4 Jun 2004 05:08:37 +0000 Subject: [PATCH] More tweaks ... using styles for code --- lang/en/docs/cvs.html | 123 +++++++++++++++---------------------- lang/en/docs/docstyles.css | 16 ++++- 2 files changed, 66 insertions(+), 73 deletions(-) diff --git a/lang/en/docs/cvs.html b/lang/en/docs/cvs.html index 6f611ab3f9..bc387fab78 100644 --- a/lang/en/docs/cvs.html +++ b/lang/en/docs/cvs.html @@ -60,44 +60,28 @@

3.1 CVS on Unix

Sourceforge CVS uses ssh as a transport layer for security, so you will have to set a CVS_RSH environment variable in your Unix shell. It's best to put these commands in your .bashrc or .cshrc so you don't have to type it all the time:

-
- 
setenv CVS_RSH ssh        (for csh, tcsh etc)
- 
export CVS_RSH=ssh        (for sh, bash etc)
-
+
setenv CVS_RSH ssh (for csh, tcsh etc)
+ export CVS_RSH=ssh (for sh, bash etc)

Next, you can check out the latest development version of Moodle using this (all one line):

-
- 
cvs -z3 -d:ext:myusername@cvs.sourceforge.net:/cvsroot/moodle co moodle
-
+
cvs -z3 -d:ext:myusername@cvs.sourceforge.net:/cvsroot/moodle co moodle

The command is similar for other CVS modules:

-
- 
cvs -z3 -d:ext:myusername@cvs.sourceforge.net:/cvsroot/moodle co contrib
-
+
cvs -z3 -d:ext:myusername@cvs.sourceforge.net:/cvsroot/moodle co contrib

Don't try to do run this first CVS command over an existing moodle installation: start fresh with a new directory.

Note that you will be prompted for mypassword for each command unless you set up authorized keys.

Now, you should have a new 'moodle' directory. You can rename it and move it around if you like. Go into it:

-
- 
cd moodle
-
+
cd moodle

All the latest Moodle files should be in there. You can now change files in your copy. To compare your files and directories against the main CVS copy on the server use cvs diff, e.g.:

-
- 
cvs diff -c config-dist.php
-cvs diff -c lang
-
+
cvs diff -c config-dist.php
+ cvs diff -c lang

To fetch the latest updates from the server use:

-
- 
cvs update -dP
-
+
cvs update -dP

To copy your new files back to the server you would do something like:

-
- 
cd lang/ca 
-cvs commit
-
+
cd lang/ca
+cvs commit

You will be prompted to add some comments (depends on your default text editor) ... add a meaningful comment and close the editor ... the files will be sent to Sourceforge and stored. Done!

To save more time you can put default arguments into a file called .cvsrc in your home directory. For example, mine contains:

-
- 
diff -c 
-update -dP
-
+
diff -c
+update -dP

Try 'cvs help' for more details ...

 

@@ -152,10 +136,14 @@ update -dP

This diagram shows how the main moodle module branches into different versions over time.

To see all the current tags and branches that are available, use this command on any old file (such as index.php in the top moodle directory):

-
- 
cvs status -v index.php
-
-

Tags and branches should ALWAYS be applied to the entire module (all of Moodle). Don't tag individual files or directories.
+

cvs status -v index.php
+

Some tagging guidelines:

+ +


 

4.1 Trunk development

@@ -170,13 +158,9 @@ update -dP

As soon as the stable branch MOODLE_XX_STABLE is created, development efforts will fork into two streams for a while. Some people may continue working on new features in the trunk for the next release, but most developers should be concentrating on using the current STABLE branch and fixing bugs that are found in it.

You can switch your local copy of Moodle to the STABLE version using the following command in Unix from the root directory:

-
- 
cvs update -dP -r MOODLE_XX_STABLE
-
+
cvs update -dP -r MOODLE_XX_STABLE

After that, all the commands described above will apply to that stable version. To return to the trunk version just issue:

-
- 
cvs update -dPA
-
+
cvs update -dPA

On Windows clients you should have a menu from which you can choose the branch.

Once the new STABLE branch really stabilises, a release can be declared. Packages are created for distribution and the branch will be tagged (by Martin) with a tag named: MOODLE_XXX

Periodically, bug fixes in the STABLE branch should be merged into the trunk so that they become available in future versions of Moodle. A floating tag called MOODLE_XX_MERGED will be maintained to keep track of the last merge. The procedure for such a merge is as follows:

@@ -184,22 +168,19 @@ update -dP
  1. Get out the very latest trunk version.

    - cvs update -dPA
    +
    cvs update -dPA
    2. -
  2. Merge everything on the branch since the last merge, into your trunk version
    -
    - cvs update -j MOODLE_13_MERGED -j MOODLE_13_STABLE
    -
    3. -
  3. Check the merged copy back into CVS trunk version
    -
    -     cvs commit
    -
    4. -
  4. Go back to the branch version
    -
    - cvs update -dPr MOODLE_13_STABLE
    -
    5. -
  5. Update the floating merge tag so that this process can be repeated next time
    -

    cvs tag -RF MOODLE_13_MERGED

    +
  6. Merge everything on the branch since the last merge, into your trunk version

    +
    cvs update -j MOODLE_13_MERGED -j MOODLE_13_STABLE
    +
    7. +
  7. Check the merged copy back into CVS trunk version

    +
    cvs commit
    +
    8. +
  8. Go back to the branch version

    +
    cvs update -dPr MOODLE_13_STABLE
    +
    9. +
  9. Update the floating merge tag so that this process can be repeated next time

    +
    cvs tag -RF MOODLE_13_MERGED
@@ -212,31 +193,29 @@ update -dP

Occasionally, there may be a very large feature that needs to be checked in so several people can work on it, but it is too unstable to be included in the main development trunk.

In these cases a short-term branch can be created to work on the feature, and then merged back into the main trunk as soon as possible. An example called MOODLE_14_WIDGET branch can be seen in the above diagram.

If you need to do this for your new WIDGET feature, follow these steps:

-
+
    -
      1. Discuss with other developers to make sure it's necessary!
        2. -
      2. Make a new tag on the trunk (for all of moodle) called MOODLE_XX_WIDGET_PRE
        -
        - cvs tag -R MOODLE_XX_WIDGET_PRE
        -
        3. -
      3. Create your branch called MOODLE_XX_WIDGET
        -
        -         cvs tag -Rb MOODLE_XX_WIDGET
        -
        4. -
      4. Work in that branch until the feature is reasonably stable. Commit as necessary.
        -
        - cvs commit
        -
        5. -
      5. When ready, merge the whole branch into the trunk, commit it to the trunk and then abandon the branch.
        -

        cvs update -dPA

        -

        cvs update -j MOODLE_XX_WIDGET

        -

        cvs commit

        +
      6. Make a new tag on the trunk (for all of moodle) called MOODLE_XX_WIDGET_PRE +

        +
        cvs tag -R MOODLE_XX_WIDGET_PRE
        7. +
      7. Create your branch called MOODLE_XX_WIDGET +

        +
        cvs tag -Rb MOODLE_XX_WIDGET
        8. +
      8. Work in that branch until the feature is reasonably stable. Commit as necessary. +

        +
        cvs commit
        9. +
      9. When ready, merge the whole branch into the trunk, commit it to the trunk and then abandon the branch. +

        +
        + cvs update -dPA
        + cvs update -j MOODLE_XX_WIDGET
        + cvs commit
        10. -
+

 

diff --git a/lang/en/docs/docstyles.css b/lang/en/docs/docstyles.css index 555c634697..319597299d 100755 --- a/lang/en/docs/docstyles.css +++ b/lang/en/docs/docstyles.css @@ -1,4 +1,3 @@ - body, td, th, li { font-family: "Trebuchet MS", Verdana, Arial, Helvetica, sans-serif; } @@ -117,3 +116,18 @@ ul { margin-top: 10px; } +.commandline { + font-family: "Courier New", Courier, mono; + font-size: x-small; + background-color: #FBFBFB; + margin: auto auto 20px 30px; + padding: 5px; + height: auto; + width: auto; + font-weight: bold; + border: 1px solid #999999; + white-space: nowrap; + display: compact; + clear: both; + float: none; +} -- 2.39.5