Skip to content

Commit

Permalink
Fix Autodoc ordering, removing InstallPackageFrom*
Browse files Browse the repository at this point in the history
  • Loading branch information
mtorpey committed Sep 19, 2024
1 parent f3d1b0f commit 68add6c
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 71 deletions.
1 change: 0 additions & 1 deletion doc/intro.autodoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,3 @@ InstallPackage("https://github.com/gap-packages/curlInterface.git");
@EndExample

@Chapter Commands
@Chapter Compilation
41 changes: 20 additions & 21 deletions gap/PackageManager.gd
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
# Declarations
#
#! @Chapter Commands

#! @Section Installing and updating packages
#! @Section Main commands

#! @Description
#! Attempts to download and install a package. The argument <A>string</A>
Expand Down Expand Up @@ -105,25 +104,6 @@ DeclareGlobalFunction("InstallPackage");
#! <K>true</K> or <K>false</K>
DeclareGlobalFunction("UpdatePackage");

#! @Description
#! Info class for the <Package>PackageManager</Package> package. Set this to
#! the following levels for different levels of information:
#! * 0 - No messages
#! * 1 - Problems only: messages describing what went wrong, with no
#! messages if an operation is successful
#! * 2 - Directories and versions: also displays informations about package
#! versions and installation directories
#! * 3 - Progress: also shows step-by-step progress of operations
#! * 4 - All: includes extra information such as whether curlInterface is
#! being used, and package info validation
#!
#! Set this using, for example `SetInfoLevel(InfoPackageManager, 1)`.
#! Default value is 3.
DeclareInfoClass("InfoPackageManager");
SetInfoLevel(InfoPackageManager, 3);

#! @Section Removing packages

#! @Description
#! Attempts to remove an installed package using its name. The first argument
#! <A>name</A> should be a string specifying the name of a package installed
Expand All @@ -147,6 +127,25 @@ SetInfoLevel(InfoPackageManager, 3);
#! <K>true</K> or <K>false</K>
DeclareGlobalFunction("RemovePackage");

#! @Section Info warnings

#! @Description
#! Info class for the <Package>PackageManager</Package> package. Set this to
#! the following levels for different levels of information:
#! * 0 - No messages
#! * 1 - Problems only: messages describing what went wrong, with no
#! messages if an operation is successful
#! * 2 - Directories and versions: also displays informations about package
#! versions and installation directories
#! * 3 - Progress: also shows step-by-step progress of operations
#! * 4 - All: includes extra information such as whether curlInterface is
#! being used, and package info validation
#!
#! Set this using, for example `SetInfoLevel(InfoPackageManager, 1)`.
#! Default value is 3.
DeclareInfoClass("InfoPackageManager");
SetInfoLevel(InfoPackageManager, 3);

DeclareGlobalFunction("PKGMAN_CheckPackage");
DeclareGlobalFunction("PKGMAN_Exec");
DeclareGlobalFunction("PKGMAN_InfoWithIndent");
Expand Down
7 changes: 0 additions & 7 deletions gap/archive.gd
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
#! @Description
#! Attempts to download and install a package from an archive located at the
#! given URL. Returns <K>true</K> if the installation was successful, and
#! <K>false</K> otherwise.
#! @Arguments url
#! @Returns
#! <K>true</K> or <K>false</K>
DeclareGlobalFunction("InstallPackageFromArchive");

DeclareGlobalFunction("PKGMAN_TarTopDirectory");
Expand Down
3 changes: 1 addition & 2 deletions gap/compile.gd
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#! @Chapter Compilation

#! @Chapter Commands
#! @Section Manual compilation

#! @Description
Expand Down
19 changes: 3 additions & 16 deletions gap/distro.gd
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,8 @@
# automatically installing dependencies.
#

#! @Description
#! Attempts to download and install a package given only its name. Returns
#! <K>false</K> if something went wrong, and <K>true</K> otherwise.
#!
#! Certain decisions, such as installing newer versions of packages, will be
#! confirmed by the user via an interactive shell &ndash; to avoid this
#! interactivity and use sane defaults instead, the optional argument
#! <A>interactive</A> can be set to <K>false</K>.
#!
#! A required version can also be specified using the optional argument
#! <A>version</A>. It works as described in the <Ref Func="InstallPackage" />
#! function.
#! @Arguments name[, version][, interactive]
#! @Returns
#! <K>true</K> or <K>false</K>
DeclareGlobalFunction("InstallPackageFromName");
#! @Chapter Commands
#! @Section Main commands

#! @Description
#! Attempts to download and install the latest versions of all packages
Expand All @@ -40,6 +26,7 @@ DeclareGlobalFunction("InstallPackageFromName");
#! <K>true</K> or <K>false</K>
DeclareGlobalFunction("InstallRequiredPackages");

DeclareGlobalFunction("InstallPackageFromName");
DeclareGlobalFunction("GetPackageURLs");
DeclareGlobalFunction("PKGMAN_InstallDependencies");

Expand Down
16 changes: 0 additions & 16 deletions gap/git.gd
Original file line number Diff line number Diff line change
@@ -1,19 +1,3 @@
#! @Description
#! Attempts to download and install a package from a git repository located at
#! the given URL. Returns <K>false</K> if something went wrong, and
#! <K>true</K> otherwise.
#!
#! If the optional string argument <A>branch</A> is specified, this function
#! will install the branch with this name. Otherwise, the repository's
#! default branch will be used.
#!
#! Certain decisions, such as installing newer versions of packages, will be
#! confirmed by the user via an interactive shell &ndash; to avoid this
#! interactivity and use sane defaults instead, the optional second argument
#! <A>interactive</A> can be set to <K>false</K>.
#! @Arguments url[, interactive][, branch]
#! @Returns
#! <K>true</K> or <K>false</K>
DeclareGlobalFunction("InstallPackageFromGit");

DeclareGlobalFunction("PKGMAN_NameOfGitRepo");
8 changes: 0 additions & 8 deletions gap/packageinfo.gd
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
#! @Description
#! Attempts to download and install a package from a valid `PackageInfo.g`
#! file. The argument <A>info</A> should be either a valid package info
#! record, or a URL that points to a valid `PackageInfo.g` file. Returns
#! <K>true</K> if the installation was successful, and <K>false</K> otherwise.
#! @Arguments info
#! @Returns
#! <K>true</K> or <K>false</K>
DeclareGlobalFunction("InstallPackageFromInfo");

DeclareGlobalFunction("PKGMAN_GetPackageInfo");
Expand Down

0 comments on commit 68add6c

Please sign in to comment.