Skip to content

Commit

Permalink
Rename doc/COMPILING/ -> doc/c++/
Browse files Browse the repository at this point in the history
  • Loading branch information
moxian committed Jan 15, 2025
1 parent 423e82b commit fd15593
Show file tree
Hide file tree
Showing 26 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion .devcontainer/cross-compile/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
RUN apt-get -y install qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools

# [Optional] comment out this section unless you want to cross-compile from Linux to Windows
# This section should align with doc/COMPILING/COMPILING.md#cross-compile-to-windows-from-linux
# This section should align with doc/c++/COMPILING.md#cross-compile-to-windows-from-linux
# With the exception of the installation of packages that are already installed earlier in the Dockerfile
# Like: astyle, cmake
RUN apt-get -y install autoconf automake autopoint bash bison bzip2 flex gettext git g++ \
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ jobs:
uses: reviewdog/action-suggester@v1
if: ${{ always() }}
with:
tool_name: '[JSON & C++ formatters](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/doc/COMPILING/DEVELOPER_TOOLING.md)'
tool_name: '[JSON & C++ formatters](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/doc/c++/DEVELOPER_TOOLING.md)'
14 changes: 7 additions & 7 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ message(STATUS "LOCALIZE : ${LOCALIZE}")
message(STATUS "USE_XDG_DIR : ${USE_XDG_DIR}")
message(STATUS "USE_HOME_DIR : ${USE_HOME_DIR}")
message(STATUS "LANGUAGES : ${LANGUAGES}")
message(STATUS "See doc/COMPILING/COMPILING-CMAKE.md for details and more info --")
message(STATUS "See doc/c++/COMPILING-CMAKE.md for details and more info --")

if (NOT MSVC)
set(CATA_WARNINGS
Expand Down Expand Up @@ -255,7 +255,7 @@ if ("${CMAKE_SOURCE_DIR}" STREQUAL "${CMAKE_BINARY_DIR}")
"This project requires an out of source build. \
Remove the file 'CMakeCache.txt' found in this directory before continuing; \
create a separate build directory and run 'cmake [options] <srcs>' from there. \
See doc/COMPILING/COMPILING-CMAKE.md for details and more info.")
See doc/c++/COMPILING-CMAKE.md for details and more info.")
endif ()

#set(THREADS_USE_PTHREADS_WIN32 True)
Expand Down Expand Up @@ -284,7 +284,7 @@ if (TILES)
"This project requires SDL2 to be installed to compile in graphical mode. \
Please install the SDL2 development libraries, \
or try compiling without -DTILES=1 for a text-only compilation. \
See doc/COMPILING/COMPILING-CMAKE.md for details and more info.")
See doc/c++/COMPILING-CMAKE.md for details and more info.")
endif ()

message(STATUS "Searching for SDL2_TTF library --")
Expand All @@ -294,7 +294,7 @@ if (TILES)
"This project requires SDL2_ttf to be installed to compile in graphical mode. \
Please install the SDL2_ttf development libraries, \
or try compiling without -DTILES=1 for a text-only compilation. \
See doc/COMPILING/COMPILING-CMAKE.md for details and more info.")
See doc/c++/COMPILING-CMAKE.md for details and more info.")
endif ()

message(STATUS "Searching for SDL2_image library --")
Expand All @@ -304,7 +304,7 @@ if (TILES)
"This project requires SDL2_image to be installed to compile in graphical mode. \
Please install the SDL2_image development libraries, \
or try compiling without -DTILES=1 for a text-only compilation. \
See doc/COMPILING/COMPILING-CMAKE.md for details and more info.")
See doc/c++/COMPILING-CMAKE.md for details and more info.")
endif ()
add_definitions(-DTILES)
endif ()
Expand Down Expand Up @@ -358,7 +358,7 @@ if (CURSES)
"This project requires ncurses to be installed to be compiled in text-only mode. \
Please install the ncurses development libraries, \
or try compiling with -DTILES=1 for a graphical compilation. \
See doc/COMPILING/COMPILING-CMAKE.md for details and more info")
See doc/c++/COMPILING-CMAKE.md for details and more info")
endif ()
if (NOT DYNAMIC_LINKING)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DNCURSES_STATIC")
Expand All @@ -374,7 +374,7 @@ if (SOUND)
message(FATAL_ERROR
"You need the SDL2_mixer development library \
to be able to compile with sound enabled. \
See doc/COMPILING/COMPILING-CMAKE.md for details and more info.")
See doc/c++/COMPILING-CMAKE.md for details and more info.")
endif()
endif ()

Expand Down
2 changes: 1 addition & 1 deletion ISSUES.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ You can update issues with labels using comment-commands. First, open a PR addin

### Questions

You should direct your questions to the forum or ask on IRC. You should also read the included documentation and additional text files, e.g. [COMPILING.md](doc/COMPILING/COMPILING.md) if you have problems building.
You should direct your questions to the forum or ask on IRC. You should also read the included documentation and additional text files, e.g. [COMPILING.md](doc/c++/COMPILING.md) if you have problems building.

## Bounties

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ Ncurses and tiles versions are available in the [official repos](https://tracker

## Compile

Please read [COMPILING.md](doc/COMPILING/COMPILING.md) - it covers general information and more specific recipes for Linux, OS X, Windows and BSD. See [COMPILER_SUPPORT.md](doc/COMPILING/COMPILER_SUPPORT.md) for details on which compilers we support. And you can always dig for more information in [doc/](https://github.com/CleverRaven/Cataclysm-DDA/tree/master/doc).
Please read [COMPILING.md](doc/c++/COMPILING.md) - it covers general information and more specific recipes for Linux, OS X, Windows and BSD. See [COMPILER_SUPPORT.md](doc/c++/COMPILER_SUPPORT.md) for details on which compilers we support. And you can always dig for more information in [doc/](https://github.com/CleverRaven/Cataclysm-DDA/tree/master/doc).

We also have the following build guides:
* Building on Windows with `MSYS2` at [COMPILING-MSYS.md](doc/COMPILING/COMPILING-MSYS.md)
* Building on Windows with `vcpkg` at [COMPILING-VS-VCPKG.md](doc/COMPILING/COMPILING-VS-VCPKG.md)
* Building with `cmake` at [COMPILING-CMAKE.md](doc/COMPILING/COMPILING-CMAKE.md) (*unofficial guide*)
* Building on Windows with `MSYS2` at [COMPILING-MSYS.md](doc/c++/COMPILING-MSYS.md)
* Building on Windows with `vcpkg` at [COMPILING-VS-VCPKG.md](doc/c++/COMPILING-VS-VCPKG.md)
* Building with `cmake` at [COMPILING-CMAKE.md](doc/c++/COMPILING-CMAKE.md) (*unofficial guide*)

## Contribute

Expand Down
8 changes: 4 additions & 4 deletions doc/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ There are a couple of guidelines we suggest sticking to (see [#Example Workflow]
## Code Style

Code style is enforced across the codebase by `astyle`.
See [CODE_STYLE](../doc/COMPILING/CODE_STYLE.md) for details.
See [CODE_STYLE](../doc/c++/CODE_STYLE.md) for details.

## Translations

Expand Down Expand Up @@ -268,7 +268,7 @@ When your PR should close an issue, please include [closing keywords](https://he

## Tooling support

Various tools are available to help you keep your contributions conforming to the appropriate style. See [DEVELOPER_TOOLING.md](../doc/COMPILING/DEVELOPER_TOOLING.md) for more details.
Various tools are available to help you keep your contributions conforming to the appropriate style. See [DEVELOPER_TOOLING.md](../doc/c++/DEVELOPER_TOOLING.md) for more details.

## Advanced Techniques

Expand Down Expand Up @@ -341,9 +341,9 @@ The test took 41.772 seconds
It is recommended to habitually invoke make like ``make YOUR BUILD OPTIONS && make check``.
If you're working with Visual Studio (and don't have `make`), see [Visual Studio-specific advice](../doc/COMPILING/COMPILING-VS-VCPKG.md#running-unit-tests).
If you're working with Visual Studio (and don't have `make`), see [Visual Studio-specific advice](../doc/c++/COMPILING-VS-VCPKG.md#running-unit-tests).
If you want/need to add a test, see [TESTING.md](../doc/COMPILING/TESTING.md)
If you want/need to add a test, see [TESTING.md](../doc/c++/TESTING.md)
## In-game testing, test environment and the debug menu
Expand Down
6 changes: 3 additions & 3 deletions doc/TESTING_YOUR_CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The [Manual of Style](MANUAL_OF_STYLE.md), applies to any proposed change,
so read this one first.

For JSON changes, read [JSON/JSON_STYLE.md](JSON/JSON_STYLE.md).
For C++ changes, read [COMPILING/CODE_STYLE.md](COMPILING/CODE_STYLE.md).
For C++ changes, read [c++/CODE_STYLE.md](c++/CODE_STYLE.md).

All released builds include a pre-compiled `json_formatter.cgi`, which
is a handy tool to automatically format any JSON file you point it at
Expand All @@ -36,8 +36,8 @@ JSON files, so after making changes, make sure to either relaunch
Cataclysm or reload your save, whatever is more convenient.

For C++ changes, you will need to compile the game yourself.
See [COMPILING.md](COMPILING/COMPILING.md).
You may also want to look at [COMPILING/TESTING.md](COMPILING/TESTING.md) for our unit
See [COMPILING.md](c++/COMPILING.md).
You may also want to look at [c++/TESTING.md](c++/TESTING.md) for our unit
tests.

## Using the debug menu
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion src/coordinate_conversions.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
* migrating to the new functions defined in coordinates.h.
*
* For documentation on coordinate systems in general see
* doc/COMPILING/POINTS_COORDINATES.md.
* doc/c++/POINTS_COORDINATES.md.
*
* Functions ending with _remain return the translated coordinates and
Expand Down
2 changes: 1 addition & 1 deletion src/coordinates.h
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ constexpr scale scale_from_origin( origin o )
*
* InBounds define if the point is guaranteed to be inbounds.
*
* For more details see doc/COMPILING/POINTS_COORDINATES.md.
* For more details see doc/c++/POINTS_COORDINATES.md.
*/
template<typename Point>
class coord_point_base
Expand Down
2 changes: 1 addition & 1 deletion src/coords_fwd.h
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ using coord_point =
* point_omt_ms is the position of a map square within an overmap terrain.
* tripoint_rel_sm is a relative tripoint submap offset.
*
* For more details see doc/COMPILING/POINTS_COORDINATES.md.
* For more details see doc/c++/POINTS_COORDINATES.md.
*/
/*@{*/
using point_rel_ms = coords::coord_point<point, coords::origin::relative, coords::ms>;
Expand Down
2 changes: 1 addition & 1 deletion src/third-party/imgui/imgui.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
// - Issues & support ........... https://github.com/ocornut/imgui/issues
// - Test Engine & Automation ... https://github.com/ocornut/imgui_test_engine (test suite, test engine to automate your apps)

// For first-time users having issues compiling/linking/running/loading fonts:
// For first-time users having issues c++/linking/running/loading fonts:
// please post in https://github.com/ocornut/imgui/discussions if you cannot find a solution in resources above.
// Everything else should be asked in 'Issues'! We are building a database of cross-linked knowledge there.

Expand Down
2 changes: 1 addition & 1 deletion src/third-party/imgui/imgui.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
// - Issues & support ........... https://github.com/ocornut/imgui/issues
// - Test Engine & Automation ... https://github.com/ocornut/imgui_test_engine (test suite, test engine to automate your apps)

// For first-time users having issues compiling/linking/running/loading fonts:
// For first-time users having issues c++/linking/running/loading fonts:
// please post in https://github.com/ocornut/imgui/discussions if you cannot find a solution in resources above.
// Everything else should be asked in 'Issues'! We are building a database of cross-linked knowledge there.

Expand Down
2 changes: 1 addition & 1 deletion tools/macos-market-share.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
# output more reasonable, but the cumulative tally does include smaller
# versions not listed.
#
# See also doc/COMPILING/COMPILER_SUPPORT.md
# See also doc/c++/COMPILER_SUPPORT.md

import csv
import re
Expand Down

0 comments on commit fd15593

Please sign in to comment.