diff --git a/.travis.yml b/.travis.yml index bba60c72..8bbe3a28 100644 --- a/.travis.yml +++ b/.travis.yml @@ -48,8 +48,8 @@ script: # Some tests call Git, so set a user - git config --global user.email "travis@ci" - git config --global user.name "Travis" - - ./loot_api_internals_tests - - ./loot_api_tests + - ./libloot_internals_tests + - ./libloot_tests after_success: - cd $TRAVIS_BUILD_DIR @@ -61,15 +61,15 @@ after_success: - git fetch --unshallow - GIT_DESCRIBE=$(git describe --tags --long --always --abbrev=7) # Make copies of the archives for GitHub deployment to find. - - cp $(ls build/package/loot_api-*.tar.xz) build/loot-api.tar.xz + - cp $(ls build/package/libloot-*.tar.xz) build/libloot.tar.xz # Need to replace the Bintray config files' version placeholders. - - sed -i "s/REPLACE_THIS_VERSION/${GIT_DESCRIBE}_${TRAVIS_BRANCH}/" scripts/travis/loot-api.bintray.json + - sed -i "s/REPLACE_THIS_VERSION/${GIT_DESCRIBE}_${TRAVIS_BRANCH}/" scripts/travis/libloot.bintray.json deploy: - provider: bintray edge: branch: v1.8.47 - file: scripts/travis/loot-api.bintray.json + file: scripts/travis/libloot.bintray.json user: wrinklyninja key: secure: "zczTW2fGiTDlrgCtDyWAcQ+FftErR8XFZ7Lz3Mnj3gbedlS7wKdpffXngpepGGQQp3N5Jt0F51mQDrRFfvgmSk0IpuSVKkzuUNt5aJEav7LYb9tho4afXGu/fd3Sj8nF0NM4rB9b2sHMKOLSBD/a+7qsf0q3W4lFZGRQPzqq6RBqB0p8brsdf4g/aoVjAGltUtagMNMYJbs5MNsZLX0Zw9pRB4bSvCf9YNXLcMckA2FQC+xiWAliMOQQlnQU5QZgzNypiTvYpyYwhLM3Xy6/QB9WkABDPEfYNcnOX7JRI81Q6QGWbbSNpDcGI1LmxDwYCftpI7ilbL+yj8Al6AFAn4Ia3AcMpoXv9De/11HYftwYL+76Lud+EaCZimy5FIj6d+GBVwiZkpnbEi8r0LJ0o9dBlLJESqSRwqhYH25fahSgfT/Tew5ftigOfJRY/sYXYXJS5TLeV7OaP6LXAivBWttB3Wo3OcE+4HsvmpgIrHGhvKsmtAQMs2ddBwKdro9jqtaCBbM2To05FtQ1/RYV2dD3v8nF7CwSX6VLp1a973CUZ5/IF3R6ONeCVwkxVqe7hPlo65NAx8L8jvxjksYIQ/r1aPhJLU7UCPPic47I/6M0fsRnT8pcRymnMcfQ5QT7h7gtqQQRJzYKaalkYVObw1ygDsqgPh5LZTf6U6S+bG8=" @@ -80,7 +80,7 @@ deploy: api_key: secure: "HBBghmIDgWsPq6YVrKh/M0au51ffWQdnaNr2QUFBEzsrMUgaAR04vd3eLtodHr5W2m6fJFfvIDnROYh2KnFQP0MFwEkldyToHpAJqoSxOJ2uJzq7TOiWTVlKbdnutQ+0GS0URcoM32uxRgkduWWe9McZ1mj12oyV2PKR2ojtNp9ni12O2qfzH32YPdQZ3zutxRgB82OZ0qj7HMHfD4v0yPhBncZaEWFTKKRy/LgJvaEGsEsb7u8MidRVpo/pNbNirjlh7Vlx4tm7kT2R4/ehH8H2y3MjxCaacfzaqi6LoGqMBVEjhpETI1COMvhezUdzmB/GBdX8zlTKuSs1GwiUl6FXnEPxnIU+qllx5PkHeph3GpkPZ8ChUuqnEksaBZsnVQ0D06KrivLb5otlRkfk4xfEX/68KUP7y/dNVZCVYOHSPD0N+iaKhGhTkjt77xJQ0z3U1qtoHrbtSdVUdeb+xIiyYCr8mHrQy+gNGqB8NLtpsdqWpjKh/BAcYnlu15VZLq6AASpLaDeBsCGXm/Er15z5meXDyRPtR1qT9XZgDEMXsn7ywe/dNfNxiY8sPxNn6vpqNvD7AR4s8nYm7qAm3JBw5xBaqh5HpkibIcNADkZGvDWjsbvO48/g1J5R+XT6CE77Qbj9UcYR532TbD0VSYFr6+snTf0Vwe1JgoiHNSk=" file: - - build/loot-api.tar.xz + - build/libloot.tar.xz skip_cleanup: true on: repo: loot/loot-api diff --git a/CMakeLists.txt b/CMakeLists.txt index 66e1f556..5cda5dc6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required (VERSION 2.8.12.1) cmake_policy(SET CMP0015 NEW) -project (loot_api) +project (libloot) include(ExternalProject) option(BUILD_SHARED_LIBS "Build a shared library" ON) @@ -185,7 +185,7 @@ set(YAML_CPP_LIBRARIES "${BINARY_DIR}/${CMAKE_CFG_INTDIR}/libyaml-cpp${YAML_CPP_ ############################## -set (LOOT_API_SRC "${CMAKE_BINARY_DIR}/generated/loot_version.cpp" +set (LIBLOOT_SRC "${CMAKE_BINARY_DIR}/generated/loot_version.cpp" "${CMAKE_SOURCE_DIR}/src/api/api.cpp" "${CMAKE_SOURCE_DIR}/src/api/api_database.cpp" "${CMAKE_SOURCE_DIR}/src/api/error_categories.cpp" @@ -215,7 +215,7 @@ set (LOOT_API_SRC "${CMAKE_BINARY_DIR}/generated/loot_version.cpp" "${CMAKE_SOURCE_DIR}/src/api/vertex.cpp" "${CMAKE_SOURCE_DIR}/src/api/resource.rc") -set (LOOT_API_HEADERS "${CMAKE_SOURCE_DIR}/include/loot/api.h" +set (LIBLOOT_HEADERS "${CMAKE_SOURCE_DIR}/include/loot/api.h" "${CMAKE_SOURCE_DIR}/include/loot/api_decorator.h" "${CMAKE_SOURCE_DIR}/include/loot/database_interface.h" "${CMAKE_SOURCE_DIR}/include/loot/exception/error_categories.h" @@ -295,22 +295,22 @@ set (LOOT_TESTS_HEADERS "${CMAKE_SOURCE_DIR}/src/tests/api/internals/game/game_t "${CMAKE_SOURCE_DIR}/src/tests/common_game_test_fixture.h" "${CMAKE_SOURCE_DIR}/src/tests/printers.h") -set(LOOT_API_TESTS_SRC "${CMAKE_SOURCE_DIR}/src/tests/api/interface/main.cpp") +set(LIBLOOT_TESTS_SRC "${CMAKE_SOURCE_DIR}/src/tests/api/interface/main.cpp") -set(LOOT_API_TESTS_HEADERS "${CMAKE_SOURCE_DIR}/src/tests/api/interface/api_game_operations_test.h" +set(LIBLOOT_TESTS_HEADERS "${CMAKE_SOURCE_DIR}/src/tests/api/interface/api_game_operations_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/interface/create_game_handle_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/interface/database_interface_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/interface/game_interface_test.h" "${CMAKE_SOURCE_DIR}/src/tests/api/interface/is_compatible_test.h" "${CMAKE_SOURCE_DIR}/src/tests/common_game_test_fixture.h") -source_group("Header Files\\api" FILES ${LOOT_API_HEADERS}) +source_group("Header Files\\api" FILES ${LIBLOOT_HEADERS}) source_group("Header Files\\tests" FILES ${LOOT_TESTS_HEADERS}) -source_group("Header Files\\tests" FILES ${LOOT_API_TESTS_HEADERS}) +source_group("Header Files\\tests" FILES ${LIBLOOT_TESTS_HEADERS}) -source_group("Source Files\\api" FILES ${LOOT_API_SRC}) +source_group("Source Files\\api" FILES ${LIBLOOT_SRC}) source_group("Source Files\\tests" FILES ${LOOT_TESTS_SRC}) -source_group("Source Files\\tests" FILES ${LOOT_API_TESTS_SRC}) +source_group("Source Files\\tests" FILES ${LIBLOOT_TESTS_SRC}) # Include source and library directories. include_directories ("${CMAKE_SOURCE_DIR}/src" @@ -387,30 +387,30 @@ ENDIF () ############################## # Build tests. -add_executable (loot_api_internals_tests ${LOOT_API_SRC} ${LOOT_API_HEADERS} ${LOOT_TESTS_SRC} ${LOOT_TESTS_HEADERS}) -add_dependencies (loot_api_internals_tests esplugin libgit2 libloadorder loot-condition-interpreter spdlog yaml-cpp GTest testing-metadata testing-plugins) -target_link_libraries(loot_api_internals_tests ${Boost_LIBRARIES} ${LIBGIT2_LIBRARIES} ${ESPLUGIN_LIBRARIES} ${LIBLOADORDER_LIBRARIES} ${LOOT_LIBS} ${LCI_LIBRARIES} ${YAML_CPP_LIBRARIES} ${GTEST_LIBRARIES}) +add_executable (libloot_internals_tests ${LIBLOOT_SRC} ${LIBLOOT_HEADERS} ${LOOT_TESTS_SRC} ${LOOT_TESTS_HEADERS}) +add_dependencies (libloot_internals_tests esplugin libgit2 libloadorder loot-condition-interpreter spdlog yaml-cpp GTest testing-metadata testing-plugins) +target_link_libraries(libloot_internals_tests ${Boost_LIBRARIES} ${LIBGIT2_LIBRARIES} ${ESPLUGIN_LIBRARIES} ${LIBLOADORDER_LIBRARIES} ${LOOT_LIBS} ${LCI_LIBRARIES} ${YAML_CPP_LIBRARIES} ${GTEST_LIBRARIES}) # Build API. -add_library (loot_api ${LOOT_API_SRC} ${LOOT_API_HEADERS}) -add_dependencies (loot_api esplugin libgit2 libloadorder loot-condition-interpreter spdlog yaml-cpp) -target_link_libraries(loot_api ${Boost_LIBRARIES} ${LIBGIT2_LIBRARIES} ${ESPLUGIN_LIBRARIES} ${LIBLOADORDER_LIBRARIES} ${LOOT_LIBS} ${LCI_LIBRARIES} ${YAML_CPP_LIBRARIES}) +add_library (loot ${LIBLOOT_SRC} ${LIBLOOT_HEADERS}) +add_dependencies (loot esplugin libgit2 libloadorder loot-condition-interpreter spdlog yaml-cpp) +target_link_libraries(loot ${Boost_LIBRARIES} ${LIBGIT2_LIBRARIES} ${ESPLUGIN_LIBRARIES} ${LIBLOADORDER_LIBRARIES} ${LOOT_LIBS} ${LCI_LIBRARIES} ${YAML_CPP_LIBRARIES}) # Build API tests. -add_executable (loot_api_tests ${LOOT_API_TESTS_SRC} ${LOOT_API_TESTS_HEADERS}) -add_dependencies (loot_api_tests loot_api GTest testing-metadata testing-plugins) -target_link_libraries(loot_api_tests loot_api ${GTEST_LIBRARIES}) +add_executable (libloot_tests ${LIBLOOT_TESTS_SRC} ${LIBLOOT_TESTS_HEADERS}) +add_dependencies (libloot_tests loot GTest testing-metadata testing-plugins) +target_link_libraries(libloot_tests loot ${GTEST_LIBRARIES}) ############################## # Set Target-Specific Flags ############################## IF (CMAKE_SYSTEM_NAME MATCHES "Windows") - set_target_properties (loot_api_internals_tests PROPERTIES COMPILE_DEFINITIONS "${COMPILE_DEFINITIONS} LOOT_STATIC") + set_target_properties (libloot_internals_tests PROPERTIES COMPILE_DEFINITIONS "${COMPILE_DEFINITIONS} LOOT_STATIC") IF (BUILD_SHARED_LIBS) - set_target_properties (loot_api PROPERTIES COMPILE_DEFINITIONS "${COMPILE_DEFINITIONS} LOOT_EXPORT") + set_target_properties (loot PROPERTIES COMPILE_DEFINITIONS "${COMPILE_DEFINITIONS} LOOT_EXPORT") ELSE () - set_target_properties (loot_api PROPERTIES COMPILE_DEFINITIONS "${COMPILE_DEFINITIONS} LOOT_STATIC") + set_target_properties (loot PROPERTIES COMPILE_DEFINITIONS "${COMPILE_DEFINITIONS} LOOT_STATIC") ENDIF () ENDIF () @@ -421,35 +421,35 @@ ENDIF () # Copy testing metadata ExternalProject_Get_Property(testing-metadata SOURCE_DIR) -add_custom_command(TARGET loot_api_internals_tests POST_BUILD +add_custom_command(TARGET libloot_internals_tests POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy_directory ${SOURCE_DIR} - "$/testing-metadata") -add_custom_command(TARGET loot_api_tests POST_BUILD + "$/testing-metadata") +add_custom_command(TARGET libloot_tests POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy_directory ${SOURCE_DIR} - "$/testing-metadata") + "$/testing-metadata") # Copy testing plugins ExternalProject_Get_Property(testing-plugins SOURCE_DIR) -add_custom_command(TARGET loot_api_internals_tests POST_BUILD +add_custom_command(TARGET libloot_internals_tests POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy_directory ${SOURCE_DIR} - $) -add_custom_command(TARGET loot_api_tests POST_BUILD + $) +add_custom_command(TARGET libloot_tests POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy_directory ${SOURCE_DIR} - $) + $) ######################################## # Install ######################################## -install(TARGETS loot_api +install(TARGETS loot DESTINATION ".") IF (MSVC) - install(FILES $ + install(FILES $ DESTINATION . OPTIONAL CONFIGURATIONS RelWithDebInfo) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c86a0f01..a6b02340 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ -Contributing To the LOOT API -============================ +Contributing To libloot +======================= A general guide to contributing to LOOT may be found on [LOOT's website](https://loot.github.io/docs/contributing/How-To-Contribute). Information more specific to this repository is found here. @@ -21,7 +21,7 @@ When you do make a pull request, please do so from a branch which doesn't have t ## Code Style -The LOOT API code style is based on the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html). Formatting style is codified in the repository's `.clang-format` file, but is not enforced. +libloot's code style is based on the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html). Formatting style is codified in the repository's `.clang-format` file, but is not enforced. ### C++ Features diff --git a/README.md b/README.md index ecc25e9c..53acbdb2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# LOOT +# libloot [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/48a540m7ywuqcl3b/branch/dev?svg=true)](https://ci.appveyor.com/project/LOOT/loot-api/branch/dev) [![Travis Build Status](https://travis-ci.org/loot/loot-api.svg?branch=dev)](https://travis-ci.org/loot/loot-api) @@ -10,17 +10,17 @@ LOOT is a plugin load order optimisation tool for TES IV: Oblivion, TES V: Skyri LOOT also provides some load order error checking, including checks for requirements, incompatibilities and cyclic dependencies. In addition, it provides a large number of plugin-specific usage notes, bug warnings and Bash Tag suggestions. -The LOOT API provides access to LOOT's metadata and sorting functionality, and the LOOT application is built using it. +libloot provides access to LOOT's metadata and sorting functionality, and the LOOT application is built using it. ## Downloads -Releases are hosted on [GitHub](https://github.com/loot/loot-api/releases), and snapshot builds are available on [Bintray](https://bintray.com/loot/snapshots/loot-api). The snapshot build archives are named like so: +Releases are hosted on [GitHub](https://github.com/loot/loot-api/releases), and snapshot builds are available on [Bintray](https://bintray.com/loot/snapshots/libloot). The snapshot build archives are named like so: ``` -loot_api---g_-.7z +libloot---g_-.7z ``` -## Building The LOOT API +## Building libloot ### Windows @@ -32,11 +32,11 @@ Refer to `.travis.yml` for the build process. A [local Docker image](https://doc ### CMake Variables -LOOT uses the following CMake variables to set build parameters: +libloot uses the following CMake variables to set build parameters: Parameter | Values | Default |Description ----------|--------|---------|----------- -`BUILD_SHARED_LIBS` | `ON`, `OFF` | `ON` | Whether or not to build a shared LOOT API binary. +`BUILD_SHARED_LIBS` | `ON`, `OFF` | `ON` | Whether or not to build a shared libloot binary. `MSVC_STATIC_RUNTIME` | `ON`, `OFF` | `OFF` | Whether to link the C++ runtime statically or not when building with MSVC. You may also need to set `BOOST_ROOT` if CMake cannot find Boost. diff --git a/appveyor.yml b/appveyor.yml index 2241daa1..2a1ec861 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -44,15 +44,15 @@ before_build: build: verbosity: minimal - project: '$(APPVEYOR_BUILD_FOLDER)\build\loot_api.sln' + project: '$(APPVEYOR_BUILD_FOLDER)\build\libloot.sln' test_script: - cd %APPVEYOR_BUILD_FOLDER%\build\%CONFIGURATION% # Some tests call Git, so set a user - git config --global user.email "appveyor@ci" - git config --global user.name "AppVeyor" - - loot_api_internals_tests.exe --gtest_output=xml:loot_api_internals_tests.xml - - loot_api_tests.exe --gtest_output=xml:loot_api_tests.xml + - libloot_internals_tests.exe --gtest_output=xml:libloot_internals_tests.xml + - libloot_tests.exe --gtest_output=xml:libloot_tests.xml after_test: - cd %APPVEYOR_BUILD_FOLDER% @@ -62,7 +62,7 @@ after_test: - cpack -C %CONFIGURATION% artifacts: - - path: build\package\loot_api-$(GIT_DESCRIBE)_$(APPVEYOR_REPO_BRANCH)-win$(ADDRESS_MODEL).7z + - path: build\package\libloot-$(GIT_DESCRIBE)_$(APPVEYOR_REPO_BRANCH)-win$(ADDRESS_MODEL).7z name: API deploy: @@ -72,14 +72,14 @@ deploy: secure: PgsEA6TjHVf718zMnK7J/fT1hUAVNKBeWhpYgYaeCyeZk37VT4Ics6j7+B7ElLEr subject: loot repo: snapshots - package: loot-api + package: libloot version: $(GIT_DESCRIBE)_$(APPVEYOR_REPO_BRANCH) publish: true artifact: API - provider: GitHub tag: $(APPVEYOR_REPO_TAG_NAME) - release: LOOT API v$(APPVEYOR_REPO_TAG_NAME) + release: libloot v$(APPVEYOR_REPO_TAG_NAME) description: | Requires Windows 7 or later and the [MSVC 2017 x86 redistributable](https://download.visualstudio.microsoft.com/download/pr/749aa419-f9e4-4578-a417-a43786af205e/d59197078cc425377be301faba7dd87a/vc_redist.x86.exe), and [7-Zip](http://www.7-zip.org/) to extract the archives. @@ -97,8 +97,8 @@ deploy: appveyor_repo_tag: true on_success: - - ps: python "$env:APPVEYOR_BUILD_FOLDER\delete_old_bintray_versions.py" -g loot/loot-api -b loot/snapshots/loot-api -u wrinklyninja -k $env:bintray_auth_token -t $env:github_auth_token -n 30 + - ps: python "$env:APPVEYOR_BUILD_FOLDER\delete_old_bintray_versions.py" -g loot/loot-api -b loot/snapshots/libloot -u wrinklyninja -k $env:bintray_auth_token -t $env:github_auth_token -n 30 on_finish: - - ps: (New-Object System.Net.WebClient).UploadFile("https://ci.appveyor.com/api/testresults/junit/$($env:APPVEYOR_JOB_ID)", "$($env:APPVEYOR_BUILD_FOLDER)\build\$($env:CONFIGURATION)\loot_api_internals_tests.xml") - - ps: (New-Object System.Net.WebClient).UploadFile("https://ci.appveyor.com/api/testresults/junit/$($env:APPVEYOR_JOB_ID)", "$($env:APPVEYOR_BUILD_FOLDER)\build\$($env:CONFIGURATION)\loot_api_tests.xml") + - ps: (New-Object System.Net.WebClient).UploadFile("https://ci.appveyor.com/api/testresults/junit/$($env:APPVEYOR_JOB_ID)", "$($env:APPVEYOR_BUILD_FOLDER)\build\$($env:CONFIGURATION)\libloot_internals_tests.xml") + - ps: (New-Object System.Net.WebClient).UploadFile("https://ci.appveyor.com/api/testresults/junit/$($env:APPVEYOR_JOB_ID)", "$($env:APPVEYOR_BUILD_FOLDER)\build\$($env:CONFIGURATION)\libloot_tests.xml") diff --git a/docs/api/Doxyfile b/docs/api/Doxyfile index 099bccf8..93b4f714 100644 --- a/docs/api/Doxyfile +++ b/docs/api/Doxyfile @@ -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 diff --git a/docs/api/changelog.rst b/docs/api/changelog.rst index f82e617a..336e8df7 100644 --- a/docs/api/changelog.rst +++ b/docs/api/changelog.rst @@ -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. diff --git a/docs/api/credits.rst b/docs/api/credits.rst index 7f950b83..dbd37973 100644 --- a/docs/api/credits.rst +++ b/docs/api/credits.rst @@ -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/ diff --git a/docs/api/introduction.rst b/docs/api/introduction.rst index d2088750..94d4b414 100644 --- a/docs/api/introduction.rst +++ b/docs/api/introduction.rst @@ -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. diff --git a/docs/conf.py b/docs/conf.py index 23f90195..f1feeadf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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'), ] diff --git a/docs/index.rst b/docs/index.rst index 18478f90..1e755f8d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ -######## -LOOT API -######## +####### +libloot +####### .. toctree:: :maxdepth: 2 diff --git a/docs/licenses/texts.rst b/docs/licenses/texts.rst index e3189ca3..a236b636 100644 --- a/docs/licenses/texts.rst +++ b/docs/licenses/texts.rst @@ -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 diff --git a/include/loot/enum/edge_type.h b/include/loot/enum/edge_type.h index fbce1722..a50e5b5b 100644 --- a/include/loot/enum/edge_type.h +++ b/include/loot/enum/edge_type.h @@ -26,7 +26,7 @@ along with LOOT. If not, see #define LOOT_EDGE_TYPE /** - * The namespace used by the LOOT API. + * The namespace used by libloot. */ namespace loot { /** diff --git a/include/loot/enum/game_type.h b/include/loot/enum/game_type.h index 38a94ed9..fad503b1 100644 --- a/include/loot/enum/game_type.h +++ b/include/loot/enum/game_type.h @@ -26,7 +26,7 @@ along with LOOT. If not, see #define LOOT_GAME_TYPE /** - * The namespace used by the LOOT API. + * The namespace used by libloot. */ namespace loot { /** @brief Codes used to create database handles for specific games. */ diff --git a/include/loot/enum/log_level.h b/include/loot/enum/log_level.h index d1a75d0d..5fbb0e84 100644 --- a/include/loot/enum/log_level.h +++ b/include/loot/enum/log_level.h @@ -26,7 +26,7 @@ along with LOOT. If not, see #define LOOT_LOG_LEVEL /** - * The namespace used by the LOOT API. + * The namespace used by libloot. */ namespace loot { /** diff --git a/include/loot/enum/message_type.h b/include/loot/enum/message_type.h index 8739d4f8..c726b7c5 100644 --- a/include/loot/enum/message_type.h +++ b/include/loot/enum/message_type.h @@ -26,7 +26,7 @@ along with LOOT. If not, see #define LOOT_MESSAGE_TYPE /** - * The namespace used by the LOOT API. + * The namespace used by libloot. */ namespace loot { /** @brief Codes used to indicate the type of a message. */ diff --git a/include/loot/loot_version.h b/include/loot/loot_version.h index a151721b..d955624b 100644 --- a/include/loot/loot_version.h +++ b/include/loot/loot_version.h @@ -32,7 +32,7 @@ along with LOOT. If not, see namespace loot { /** * @brief A purely static class that provides information about the version of - * the LOOT API that is being run. + * libloot that is being run. */ class LootVersion { public: diff --git a/scripts/set_version_number.py b/scripts/set_version_number.py index 99b1fdb9..b53c8753 100644 --- a/scripts/set_version_number.py +++ b/scripts/set_version_number.py @@ -31,7 +31,7 @@ def update_resource_file(path, version): replace_in_file(path, 'Version", "\d+\.\d+\.\d+"', 'Version", "{}"'.format(version)) if __name__ == "__main__": - parser = argparse.ArgumentParser(description = 'Set the LOOT API version number') + parser = argparse.ArgumentParser(description = 'Set the libloot version number') parser.add_argument('version', nargs='+') arguments = parser.parse_args() diff --git a/scripts/travis/loot-api.bintray.json b/scripts/travis/libloot.bintray.json similarity index 68% rename from scripts/travis/loot-api.bintray.json rename to scripts/travis/libloot.bintray.json index 96ffe873..e24656f2 100644 --- a/scripts/travis/loot-api.bintray.json +++ b/scripts/travis/libloot.bintray.json @@ -1,6 +1,6 @@ { "package": { - "name": "loot-api", + "name": "libloot", "repo": "snapshots", "subject": "loot" }, @@ -8,7 +8,7 @@ "name": "REPLACE_THIS_VERSION" }, "files": [{ - "includePattern": "build/package/(loot_api-.+\\.tar.xz)", + "includePattern": "build/package/(libloot-.+\\.tar.xz)", "uploadPattern": "$1" }], "publish": true