Add some more comments on the feeds script, use parameters in functions

SVN-Revision: 5985

scripts/feeds.sh

@@ -4,15 +4,17 @@
 # This is free software, licensed under the GNU General Public License v2.
 # See /LICENSE for more information.
 #
-# Usage : $1 -> source feeds
+# Usage : $1 -> source feeds, space separated
-# 	  $2 -> other options
+# 	  $2 -> other options (not used yet)
 #
 # Note : we do not yet resolve package name conflicts
 #
-#
+
+# Directories
 FEEDS_DIR=$TOPDIR/feeds
 PACKAGE_DIR=$TOPDIR/package
 
+# We work in the TOPDIR as defined in the caller Makefile
 cd $TOPDIR
 # This directory will be structured this way : feeds/feed-name
 [ -d $FEEDS_DIR ] || mkdir -p $FEEDS_DIR
@@ -20,23 +22,24 @@ cd $TOPDIR
 
 # Some functions we might call several times a run
 delete_symlinks() {
-	find $PACKAGE_DIR -type l | xargs rm -f
+	find $1 -type l | xargs rm -f
 }
 
 setup_symlinks() {
 	# We assume that feeds do reproduce the hierarchy : section/package
-	for dir in $(ls $FEEDS_DIR/)
+	# so that we can make this structure be flat in $PACKAGE_DIR
+	for dir in $(ls $2/)
 	do
-		ln -s $FEEDS_DIR/$dir/*/* $PACKAGE_DIR/
+		ln -s $2/$dir/*/* $1/
 	done
 }
 
 checkout_feed() {
-	# We ensure the feed has not already been checkout, if so, just update the source feed
+	# We ensure the feed has not already been checked out, if so, we just update the source feed
 	if [ -d $FEEDS_DIR/$2 ]; then
 		svn update $FEEDS_DIR/$2
 		echo "Updated to revision $(LANG=C svn info $FEEDS_DIR/$2 | awk '/^Revision:/ { print $2 }' )";
-	# Otherwise, we have to checkout in the 
+	# Otherwise, we have to checkout in the $FEEDS_DIR 
 	else
 		svn co $1 $FEEDS_DIR/$2
 		echo "Checked out revision $(LANG=C svn info $FEEDS_DIR/$2 | awk '/^Revision:/ { print $2 }' )";
@@ -44,11 +47,12 @@ checkout_feed() {
 }
 
 extract_feed_name() {
+	# We extract the last name of the URL, maybe we should rename this as domain.tld.repository.name
 	echo "$(echo $1 | awk -F/ '{ print $NF}')"
 }
 
-# We can delete symlinks every time we start this script, since modifications have been made anyway
+# We can delete symlinks every time we start this script, since modifications have been made in the $FEEDS_DIR anyway
-delete_symlinks ""
+delete_symlinks "$PACKAGE_DIR"
 # Now let's checkout feeds
 for feed in $1
 do
@@ -56,4 +60,4 @@ do
 	checkout_feed "$feed" "$name"
 done
 # Finally setup symlinks
-setup_symlinks ""
+setup_symlinks "$FEEDS_DIR" "$PACKAGE_DIR"