Rename "LOOT API" to "libloot"

To avoid confusion when talking about the library vs. its API. The GitHub
repository has not yet been renamed, so all references to it are
unchanged.
This commit is contained in:
Oliver Hamlet
2018-11-17 18:43:07 +00:00
parent 1e520aff54
commit 5bb20daa82
19 changed files with 82 additions and 78 deletions
+1 -1
View File
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = "LOOT API"
PROJECT_NAME = "libloot"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
+4
View File
@@ -25,6 +25,10 @@ Added
Changed
-------
- Renamed the library from "the LOOT API" to "libloot" to avoid confusion
between the name of the library and the API that it provides. The library
filename is changed so that the ``loot_api`` part is now ``loot``, e.g.
``loot.dll`` on Windows and ``libloot.so`` on Linux.
- :cpp:any:`CyclicInteractionError` has had its constructor and methods
completely replaced to provide a more detailed and flexible representation of
the cyclic path that it reports.
+2 -2
View File
@@ -2,10 +2,10 @@
Credits
*******
The LOOT API is written by `Ortham`_ in C++ and makes use of the `Boost`_,
libloot is written by `Ortham`_ in C++ and makes use of the `Boost`_,
`esplugin`_, `libgit2`_, `libloadorder`_, `loot-condition-interpreter`_,
`spdlog`_ and `yaml-cpp`_ libraries. The copyright licenses for all of these and
the LOOT API itself in :doc:`../licenses/texts`.
libloot itself in :doc:`../licenses/texts`.
.. _Ortham: https://github.com/Ortham
.. _Boost: http://www.boost.org/
+1 -1
View File
@@ -11,5 +11,5 @@ thousands of Bash Tag suggestions.
This metadata that LOOT supplies is stored in its masterlist, which is
maintained by the LOOT team using information provided by mod authors and users.
Users can also add to and modify the metadata used by LOOT through the use of
userlist files. The LOOT API provides a way for third-party developers to access
userlist files. libloot provides a way for third-party developers to access
this metadata for use in their own programs.
+5 -5
View File
@@ -59,7 +59,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'LOOT API'
project = u'libloot'
copyright = u'2016, WrinklyNinja'
author = u'WrinklyNinja'
@@ -270,7 +270,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'loot_api.tex', u'LOOT API Documentation',
(master_doc, 'libloot.tex', u'libloot Documentation',
u'WrinklyNinja', 'manual'),
]
@@ -312,7 +312,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'loot_api', u'LOOT API Documentation',
(master_doc, 'libloot', u'libloot Documentation',
[author], 1)
]
@@ -327,8 +327,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'loot_api', u'LOOT API Documentation',
author, 'loot_api', 'One line description of project.',
(master_doc, 'libloot', u'libloot Documentation',
author, 'libloot', 'One line description of project.',
'Miscellaneous'),
]
+3 -3
View File
@@ -1,6 +1,6 @@
########
LOOT API
########
#######
libloot
#######
.. toctree::
:maxdepth: 2
+2 -2
View File
@@ -20,7 +20,7 @@ Copyright License Texts
.. include:: GNU GPL v2 (libgit2).txt
:literal:
LOOT API, `esplugin`_ & `Libloadorder`_
libloot, `esplugin`_ & `Libloadorder`_
======================================
.. _esplugin: https://github.com/Ortham/esplugin
@@ -29,7 +29,7 @@ LOOT API, `esplugin`_ & `Libloadorder`_
.. include:: GNU GPL v3.txt
:literal:
LOOT API Documentation
libloot Documentation
======================
.. include:: GNU FDL v1.3.txt