Changeset 364

Timestamp:

02/10/11 00:42:25 (13 years ago)

Author:

misc

Message:

enhance documentation fix typo

File:

• server/trunk/web/lib/Sophie/Controller/Distrib.pm (modified) (14 diffs)

server/trunk/web/lib/Sophie/Controller/Distrib.pm

@@ -146 +146 @@
 =head2 distrib.exists( DISTRIB )
 
-Return true or false if disteibution C<DISTRIB> exists.
+Return true or false if distribution C<DISTRIB> exists.
 
 C<DISTRIB> is a structure with following key/value:
@@ -166 +166 @@
 =back
 
-This function is usefull to check if a search have chance to suceed, eg if the
-user is not searching a rpm on a not existing ditribution.
+This function is useful to check if a search have chance to succeed, eg if the
+user is not searching a rpm on a non existing distribution.
 
 =cut
@@ -189 +189 @@
 =head2 Url: /distrib
 
-Return the list of currently stored distributions.
+Return the list of currently indexed distributions.
 
 =cut
@@ -208 +208 @@
 =head2 Url: /distrib/<DISTRIBUTION>
 
-Return the list of available release for given C<DISTRIBUTION>.
+Return the list of available releases for given C<DISTRIBUTION>.
 
 =cut
@@ -226 +226 @@
 =head2 Url: /distrib/<DISTRIBUTION>/<RELEASE>
 
-Return the list of available architecture for given C<DISTRIBUTION>,
+Return the list of available architectures for given C<DISTRIBUTION>,
 C<RELEASE>.
 
@@ -304 +304 @@
 =item arch
 
-The arch name
+The archictecture name
 
 =back
@@ -356 +356 @@
 =item arch
 
-The arch name
+The architecture name
 
 =back
@@ -394 +394 @@
 =head2 distrib.srpms( DISTRIB )
 
-Return a list of sources packages available for C<DISTRIB>.
+Return a list of source packages available for C<DISTRIB>.
 
 C<DISTRIB> is a struct with following keys/values:
@@ -410 +410 @@
 =item arch
 
-The arch name
+The architecture name
 
 =back
@@ -499 +499 @@
 =head2 Url: /distrib/<DISTRIBUTION>/<RELEASE>/<ARCH>/srpms
 
-Return the list of available sources rpms for given C<DISTRIBUTION>,
+Return the list of available source rpms for given C<DISTRIBUTION>,
 C<RELEASE>, C<ARCH>.
 
@@ -525 +525 @@
 =head2 Url: /distrib/<DISTRIBUTION>/<RELEASE>/<ARCH>/srpms/<RPMNAME>
 
-Show the highter version of source rpm named C<RPMNAME> for given
+Show the highest version of source rpm named C<RPMNAME> for given
 C<DISTRIBUTION>, C<RELEASE>, C<ARCH>.
 
@@ -545 +545 @@
 =head2 Url: /distrib/<DISTRIBUTION>/<RELEASE>/<ARCH>/rpms/<RPMNAME>
 
-Show the highter version of binary rpm named C<RPMNAME> for given
+Show the highest version of binary rpm named C<RPMNAME> for given
 C<DISTRIBUTION>, C<RELEASE>, C<ARCH>.
 
@@ -569 +569 @@
 C<DISTRIBUTION>, C<RELEASE>, C<ARCH>.
 
-This is likelly the same thing than C</rpm/PKGID> but website will return 404
-error if the rpm is not in this distrib
+This is likely the same thing than C</rpm/PKGID> but website will return a 404
+error code if the rpm is not in this distrib
 
 =cut
@@ -608 +608 @@
 C<RELEASE>, C<ARCH>.
 
-The return list is an array of struct:
+The result list is an array of struct:
 
     [