mirror of https://gitlab.com/basile.b/dexed.git
doc
This commit is contained in:
Basile Burg
parent
d52aa93500
commit
38da3ff216
|
|
@ -10,8 +10,7 @@ The library manager (aka the _libman_) is designed to replace the _sc.ini_ or th
|
|||
Despite of its simplistic look it's a central component of the software. The [completion](features_dcd), the [runnables](features_runnables), the CE project format strongly rely on it.
|
||||
|
||||
The _libman_ links the library files (_*.lib_ or _*.a_) to their D sources and are represented with a simple **alias** that is used in different part of the software.
|
||||
For example, in a project, you don't need anymore to specify the **-I** path nor its matching library file name.
|
||||
Coedit handles the task automatically (see later in the project configuration widget, [general options][lnk_widg_prjconf_gen]).
|
||||
For example, in a CE project, you don't need to specify the **-I** path nor its matching library file name, this is done automatically.
|
||||
|
||||
|
||||
|
||||
|
|
@ -28,7 +27,7 @@ This features is only used for the CE project format and the [runnables](feature
|
|||
-  **/** : Changes selected entry position.
|
||||
- : If the current project is a static library then the _libman_ will use its parameters to create an entry. This avoids to browse in the dialogs. Note that sometimes the sources root folder has to be adjusted.
|
||||
- : If the selected item defines a _project_ then closes current project and opens the one matching to the entry.
|
||||
- : Allows to fetch the master version of a [DUB registry item](http://code.dlang.org/). See the last section.
|
||||
- : Allows to fetch the master version of a [DUB registry item](http://code.dlang.org/). See the last section.
|
||||
- : enable or disable the selected entry. This is mainly useful to test new DMD versions since the libraries often have to be recompiled from a version to another.
|
||||
- : edit the item alias.
|
||||
- : select the library file. In some rare case, this field can be omitted (for example if the library file is set in the _sc.ini_).
|
||||
|
|
@ -41,11 +40,11 @@ This can be skipped if the library is only a small orphan _d_ source that's not
|
|||
|
||||
When the toolbar button that displays DUB logo is clicked, a dialog is displayed. It used to select an online package that will be downloaded, compiled and automatically installed in the _libman_
|
||||
|
||||
![img/dub_register_package]
|
||||
|
||||
|
||||
The text field is used to select the name of the package to install.
|
||||
|
||||
- : Update the list of the online packages.
|
||||
- : Update the list of the online packages.
|
||||
- : By the default the master version of the package is installed. When the tag button is down Coedit rather installs the package from its latest tag.
|
||||
- : Closes the dialog and start downloading before installing.
|
||||
- : Cancels and does nothing.
|
||||
|
|
@ -305,37 +305,6 @@ Notes:
|
|||
- To find the declaration of a symbol, <kbd>Ctrl</kbd> + <kbd>MB Left</kbd> or the [symbol list][lnk_widg_symlist] are faster.
|
||||
- To rename a variable or a type, local identifier renaming (<kbd>Ctrl</kbd> + <kbd>F2</kbd>) can be more accurate than _Replace all_ since this uses the semantic.
|
||||
|
||||
## Library manager widget
|
||||
|
||||
The library manager (aka the _libman_) is designed to replace the _sc.ini_ or the _sc.conf_ file to manage the static libraries.
|
||||
Despite of its simplistic look it's a central component of the software.
|
||||
|
||||
The _libman_ links the library files (_*.lib_ or _*.a_) to their D sources and are represented with a simple **alias** that is used in different part of the software.
|
||||
For example, in a project, you don't need anymore to specify the **-I** path nor its matching library file name.
|
||||
Coedit handles the task automatically (see later in the project configuration widget, [general options][lnk_widg_prjconf_gen]).
|
||||
|
||||
|
||||
|
||||
- : add a library item, by default its fields are initialized with _n/a_.
|
||||
- : remove the selected item.
|
||||
-  **/** : change selected entry position.
|
||||
- : if the current project _binaryKind_ is set to _staticlib_ then the _libman_ will use its parameters to create an entry. This avoids to browse in the dialogs, for example if you wish to setup several [_metad_][lnk_metad] items. Note that sometimes the sources root folder has to be adjusted.
|
||||
- : if the selected item defines a _project_ then closes current project and opens the one matching to the entry.
|
||||
- : allows to fetch the master version of a [DUB registry item](http://code.dlang.org/). When the button is clicked, a dialog is displayed. It allows to type the name of the library to download or to select a library in a list obtained from the official repository. After validation and if the name is valid, the library will be downloaded, compiled and a new entry automatically filled. This features is actually more useful for the CE projects and the runnable modules since the dependencies of a DUB projects are handled automatically. It allows to use any DUB library in a CE project, even if the package doesn't include a CE project file. Note well that this feature works even if the target project is described with the _SDL_ format.
|
||||
- : enable or disable the selected entry. This is mainly useful to test new DMD versions since the libraries often have to be recompiled from a version to another.
|
||||
- : edit the item alias.
|
||||
- : select the library file. In some rare case, this field can be omitted (for example if the library file is set in the _sc.ini_).
|
||||
This can be skipped if the library is only a small orphan _d_ source that's not been compiled as a static library or if the entry is only used for the [DCD][lnk_dcd] completion.
|
||||
- : select a folder that contains several libraries files or several orphans modules.
|
||||
- : select the sources root folder. (the one commonly named 'import').
|
||||
- : set the project file that matches to the selected item.
|
||||
|
||||
If they're not automatically detected, it's recommended to add the _runtime library_ and _phobos_.
|
||||
A collection of third party libraries are provided by the [_metad_][lnk_metad] repository.
|
||||
All of them can be easily build in Coedit and setup in the [_libman_](lnk_widg_lib).
|
||||
|
||||
The library entries are saved in the user folder [(see options)][lnk_widg_opts] as _libraryManager.txt_.
|
||||
|
||||
## Project configuration widget
|
||||
|
||||
The project configuration widget is a powerful editor for the compiler options. By design it uses an "_Object Inspector_" GUI element.
|
||||
|
|
|
|||
Loading…
Reference in New Issue