Skip to content

Commit

Permalink
Update doc/modules with the new modules
Browse files Browse the repository at this point in the history
  • Loading branch information
AltGr committed Apr 10, 2015
1 parent a6e26e1 commit 29a0cdf
Showing 1 changed file with 38 additions and 25 deletions.
63 changes: 38 additions & 25 deletions doc/modules
Original file line number Diff line number Diff line change
@@ -1,30 +1,17 @@
src
├── client Everything related to the OPAM state, installation and front-end
│   │   [ opam-client lib ]
│   │   # State and actions
│   ├── opamSolution.ml Interface with the solver, processing of full solutions through actions
│   ├── opamAction.ml Handles concrete actions on packages, like installations and removals
│   ├── opamState.ml Functions handling a global state corresponding to the on-disk ~/.opam, plus (too) many auxiliary and manipulation functions
│   │   # User command handling
│   ├── opamClient.ml High-level execution of user-facing functions like "upgrade", and wrappers around the *Command modules
│   ├── opamConfigCommand.ml Functions for the "opam config" subcommand
│   ├── opamPinCommand.ml Functions for the "opam pin" subcommand
│   ├── opamRepositoryCommand.ml Functions for the "opam repository" subcommand
│   ├── opamSwitchCommand.ml Functions for the "opam switch" subcommand
│   │   [ opam exe ]
│   ├── opamGitVersion.mli (generated) Current git version of OPAM
│   ├── opamArg.ml Command-line argument parser (opam exec only)
│   └── opamMain.ml Main
├── core Library of functions needed by OPAM, system and file support, OPAM file-format, global variables
├── core Library of functions needed by OPAM, system and file support, OPAM file-format
│   │   [ opam-core lib ]
│   ├── opamVersion.ml (generated) Current OPAM version
│   ├── opamScript.mli (generated) Shell config scripts as OCaml strings
│   ├── opamMisc.ml Generic stdlib functions (string_split, Option submodule...)
│   ├── opamCoreConfig.ml Configuration options for this lib (record, global reference and setter)
│   ├── opamVersionCompare.ml Version comparison function used throughout. From the Dose suite.
│   ├── opamStd.ml Generic stdlib functions (String, List, Option, Sys submodules...)
│   ├── opamConsole.ml Console output, ANSI color, logging and user querying
│   ├── opamTypes.mli Definitions of many types used throughout
│   ├── opamTypesBase.ml Helper functions on the base types. Often opened
│   ├── opamCompat.ml.4.01/4.02 Compatibility layer (Bytes, etc.) for different OCaml versions
│   ├── opamGlobals.ml Global configuration references of general use ("debug","root"...)
│   ├── opamGlobals.ml Configuration initialisation helpers (using the environment), and a few global static strings
│   │   # basic types, used as keys
│   ├── opamCompiler.ml The compiler type (string, version pairs)
│   ├── opamPackage.ml The package type, and package name type (name+version, values often called "nv" in the code)
@@ -40,31 +27,57 @@ src
│   │   # more advanced types
│   ├── opamFilter.ml Formulas on variables, as used in opam files build scripts
│   ├── opamFormula.ml Formulas on packages, opt. with sub-formulas on versions, and conversion functions
│   ├── opamRepository.ml Repositories, and operations (update, download...) on top of the opam-repository lib
│   │   # file format
│   ├── opamJson.ml Wrapper on Jsonm; only needed for some (as of now) unused debug options
│   ├── opamLineLexer.mll A simple lexer to list of lines, which are lists of words
│   ├── opamLexer.mll OPAM config file lexer
│   ├── opamParser.mly OPAM config file generic type parser
│   ├── opamFormat.ml OPAM config files syntax and conversion tools, printing
│   ├── opamFile.ml Handles all OPAM file formats as record types and submodules, conversion to and from syntax
│   └── opamPath.ml Defines all paths under ~/.opam using a hierarchy of modules
│   └── opamFile.ml Handles all OPAM file formats as record types and submodules, conversion to and from syntax
├── repositories Handling of remote sources
│   │   [ opam-repositories lib ]
├── repository Handling of remote sources
│   │   [ opam-repository lib ]
│   ├── opamRepositoryConfig.ml Configuration options for this lib (record, global reference and setter)
│   ├── opamRepositoryBackend.ml Signature for repository handlers and some helpers for the repository type
│   ├── opamRepositoryPath.ml Defines the file hierarchy in repositories
│   ├── opamDownload.ml Configuration init and handling of downloading commands
│   ├── opamHTTP.ml Main HTTP backend
│   ├── opamLocal.ml Rsync backend, for local or ssh sources
│   ├── opamVCS.ml Layer for handling version control sources
│   ├── opamDarcs.ml Darcs support (through OpamVCS)
│   ├── opamGit.ml Git support (through OpamVCS)
│   └── opamHg.ml Mercurial support (through OpamVCS)
│   ├── opamHg.ml Mercurial support (through OpamVCS)
│   └── opamRepository.ml Operations on repositories (update, fetch...) based on the above backends
├── solver Solver and Cudf interaction
│   │   [ opam-solver lib ]
│   ├── opamSolverConfig.ml Configuration options for this lib (record, global reference and setter)
│   ├── opamSolverGlobals.ml Configuration initialisation and accessors
│   ├── opamCudf.ml Solver interaction, conversion of answer to solution
│   ├── opamHeuristic.ml The "internal solver", brute-force search using Dose's checker
│   └── opamSolver.ml Entry point, conversion of universe to cudf, dependencies computation
├── client Everything related to the OPAM state, installation and front-end
│   │   [ opam-client lib ]
│   │   # Setup
│   ├── opamClientConfig.ml Configuration options for this lib (record, global reference and setter)
│   ├── opamClientGlobals.ml Configuration initialisation and file loading, OCaml specifics detection
│   │   # State and actions
│   ├── opamPath.ml Defines the file hierarchy in ~/.opam
│   ├── opamSolution.ml Interface with the solver, processing of full solutions through actions
│   ├── opamAction.ml Handles concrete actions on packages, like installations and removals
│   ├── opamState.ml Functions handling a global state corresponding to the on-disk ~/.opam, plus (too) many auxiliary and manipulation functions
│   │   # User command handling
│   ├── opamConfigCommand.ml Functions for the "opam config" subcommand
│   ├── opamPinCommand.ml Functions for the "opam pin" subcommand
│   ├── opamRepositoryCommand.ml Functions for the "opam repository" subcommand
│   ├── opamSwitchCommand.ml Functions for the "opam switch" subcommand
│   ├── opamClient.ml High-level execution of user-facing functions like "upgrade", and wrappers around the *Command modules
│   │   [ opam exe ]
│   ├── opamGitVersion.mli (generated) Current git version of OPAM
│   ├── opamArg.ml Command-line argument parser (opam exec only)
│   └── opamMain.ml Main
└── tools
│   [ opam-admin tool ]
├── opam_mk_repo.ml Repo index and archives generation

0 comments on commit 29a0cdf

Please sign in to comment.