Index: openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp,v
diff -u -r1.5.2.11 -r1.5.2.12
--- openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp 19 Oct 2022 09:31:56 -0000 1.5.2.11
+++ openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp 13 Jul 2023 12:43:19 -0000 1.5.2.12
@@ -1,24 +1,24 @@
- All OpenACS code is available anonymously. To get code
anonymously, use the parameter If you are an OpenACS developer, you should check out code so
@@ -37,7 +37,8 @@
With this setup, you will be asked for your password with each
cvs command. To avoid this, set up ssh certificate authentication
@@ -53,20 +54,22 @@
Administrator Note: These are the steps to grant CVS commit
rights to a user: Create the user's account. On cvs.openacs.org: Create the user's account. On cvs.openacs.org: Grant cvs access to the user account. On any machine, in a
temporary directory: Add an avail line of the form: Add an avail line of the form: If you are actively developing a non-core package, you should
work from the latest core release branch. Currently this is
oacs-5-9. This ensures that you are working on top of a stable
OpenACS core, but still allows you to commit feature changes to
@@ -94,7 +97,7 @@
packages and their current state. If you are actively developing packages in the OpenACS Core,
work from the HEAD branch. HEAD is used for active development of
the next version of core OpenACS. It may be very buggy; it may not
even install correctly. Do not use this branch for development of
@@ -103,7 +106,7 @@
developer account: To check out HEAD anonymously: .LRN consists of a given version OpenACS core, plus a set of
packages. These are collectively packages together to form a
distribution of .LRN. F .LRN 2.0.0 sits on top of OpenACS 5.0.0.
.LRN also uses an OpenACS install.xml file during installation;
@@ -128,7 +131,7 @@
All OpenACS code resides within a single CVS module,
The complete list of core packages is:-d:pserver:anonymous\@cvs.openacs.org:/cvsroot
immediately after cvs
in a cvs
command to check out or export code.export CVS_RSH=ssh
into
~/.bash_profile
.). If your
local account name does not match your cvs.openacs.org account
-name, create a file ~/.ssh/config
with an entry like:Host cvs.openacs.org
+name, create a file
~/.ssh/config
with an entry like:
+Host cvs.openacs.org
User joel
sudo bash
-adduser --add_extra_groups cvs --gecos "Real Name" --shell /bin/bash username
-
+sudo bash
+adduser --add_extra_groups cvs --gecos "Real Name" --shell /bin/bash username
+
cvs -d :ext:cvs.openacs.org:/cvsroot co CVSROOT
cd CVSROOT
-emacs avail
avail|username|openacs-4
cvs commit -m "added commit on X for username" avail
+emacs avail
+avail|username|openacs-4
+
cvs commit -m "added commit on X for username" avail
cvs -d:ext:cvs.openacs.org:/cvsroot checkout acs-core
cvs -d:pserver:anonymous\@cvs.openacs.org:/cvsroot checkout acs-core
openacs-4
. (The openacs-4
directory contains code for all versions of OpenACS 4 and later,
and .LRN 1 and later.) Checking out this module retrieves all
@@ -137,7 +140,8 @@
acs-core
contains only
critical common packages. It does not have any user applications,
such as forums, bug-tracker, calendar, or ecommerce. These can be
-added at any time.acs-admin
+added at any time.
The complete list of core packages is:
+acs-admin acs-api-browser acs-authentication acs-automated-testing @@ -153,7 +157,8 @@ acs-subsite acs-tcl acs-templating -ref-timezones search
+ref-timezones search +
dotlrn-all
contains the
packages required, in combination with acs-core, to run the .LRN
system.
@@ -163,7 +168,7 @@ module of the same name.
Tags and Branches look similar in commands, but behave differently. A tag is a fixed point on a branch. Check out a tag to get a specific version of OpenACS. Check out a branch to get the most current code for that major-minor version (e.g., 5.0.x or @@ -233,8 +238,9 @@ repository:
Use one of the checkout methods described above to get files to your system. This takes the place of steps 1 and 2 in the section called -“Installation Option 2: Install from tarball”. Continue setting -up the site as described there.
Fix bugs and add features.
Fix bugs and add features.
Commit that file (or files):
cvs commit -m "what I did and why" filename
Because this occurs in your personal checkout and not an
anonymous one, this commit automagically moves back upstream to the
Mother Ship repository at cvs.openacs.org. The names of the changed
@@ -265,6 +271,7 @@
Checking in modules;
/cvsroot/CVSROOT/modules,v <-- modules
+
new revision: 1.94; previous revision: 1.93
done
@@ -273,11 +280,13 @@
Although you should add your package on HEAD, you should do package development on the latest release branch that your code is compatible with. So, after completing the import, you may want to -branch your package:
cd /var/lib/aolserver/service0/packages/newpackage +branch your package:+cd /var/lib/aolserver/service0/packages/newpackage cvs tag -b oacs-5-1
See the section called -“How to package and release an OpenACS Package” +“How to package and release an OpenACS +Package”
Some packages are already in cvs at openacs-4/contrib/packages
. Starting with
@@ -286,7 +295,9 @@
un-necessary. If you are working on a contrib
package, you should move it to
/packages
. This must be done by
an OpenACS administrator. On cvs.openacs.org:
cp -r /cvsroot/openacs-4/contrib/packages/package0 /cvsroot/openacs-4/packages
Update the modules file as described above.
Remove the directory from cvs in the old location using +
+cp -r /cvsroot/openacs-4/contrib/packages/package0 /cvsroot/openacs-4/packages
+
Update the modules file as described above.
Remove the directory from cvs in the old location using
cvs rm
. One approach
for file in `find | grep -v CVS`; do
rm $file; cvs remove $file; done
@@ -403,7 +414,7 @@
Informal guidelines which may be obsolete in places and should be reviewed:
Before committing to cvs you must submit a bug report and patch to the OpenACS bug