Skip to content

Remove buildcc base namespace and complete documentation #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 40 commits into from
Jan 20, 2022
Merged

Remove buildcc base namespace and complete documentation #186

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
d7fc226
Removed toolchain from namespace buildcc::base and added it to buildcc
coder137 Jan 16, 2022
9750ee8
Update test_toolchain_verify.cpp
coder137 Jan 16, 2022
596515d
Changed TargetEnv namespace from buildcc::base to buildcc
coder137 Jan 17, 2022
3a0abe2
Updated TargetConfig and TargetFileExt namespace from buildcc::base t…
coder137 Jan 17, 2022
427d384
Shifted TargetType from namespace buildcc::base to buildcc
coder137 Jan 17, 2022
a3d0bdb
Shifted TargetState namespace from buildcc::base to buildcc
coder137 Jan 17, 2022
b9bb12a
Shifted BuilderInterface from buildcc::base to buildcc::internal
coder137 Jan 17, 2022
3f31473
Shifted Generator from namespace buildcc::base to buildcc
coder137 Jan 17, 2022
97dc77b
Update target.rst
coder137 Jan 17, 2022
2ff11a3
Shift Api CRTP class from buildcc::base to buildcc::internal
coder137 Jan 18, 2022
7603e0d
Update target_info.h
coder137 Jan 18, 2022
e739d9e
Shifted TargetGetter namespace from buildcc::base to buildcc::internal
coder137 Jan 18, 2022
7e95a6a
Renamed buildcc::base::Target to buildcc::BaseTarget
coder137 Jan 18, 2022
3df4c24
Migrated Target from namespace buildcc::base to buildcc
coder137 Jan 18, 2022
687d07a
Updated CompileObject, CompilePch and LinkTarget namespace from build…
coder137 Jan 18, 2022
b0b6654
Minor naming updates
coder137 Jan 18, 2022
0301d50
Updated toolchain documentation
coder137 Jan 18, 2022
0fb0907
Updated specialized toolchain documentation
coder137 Jan 18, 2022
a148ff5
Updated generator documentation
coder137 Jan 18, 2022
6f595f9
Added target_utils
coder137 Jan 19, 2022
8570f82
Updated generator.rst
coder137 Jan 19, 2022
ec5f7bc
Updated target_utils with TargetFileExt and TargetConfig
coder137 Jan 19, 2022
ea9fa67
Update target_config.h
coder137 Jan 19, 2022
c35726c
Updated environment APIs
coder137 Jan 19, 2022
20b99d5
Update target_config.h
coder137 Jan 19, 2022
5a98122
Update target_config.h
coder137 Jan 19, 2022
9a44e20
Update target.rst
coder137 Jan 19, 2022
929e1cb
Update target.rst
coder137 Jan 19, 2022
ab43c57
Update target.rst
coder137 Jan 19, 2022
5602a77
Updated target utils
coder137 Jan 19, 2022
dc7086a
Update target.rst
coder137 Jan 19, 2022
71d7abc
Update TODO.md
coder137 Jan 19, 2022
9c04fb8
Update namespaces.rst
coder137 Jan 19, 2022
dea0296
Update target.rst
coder137 Jan 20, 2022
99e1219
Added compile.toml, immediate.toml and README for single example
coder137 Jan 20, 2022
0319d2a
Update testing.rst
coder137 Jan 20, 2022
9e0db6c
Update environment.rst
coder137 Jan 20, 2022
1bb7bd3
Update walkthroughs.rst
coder137 Jan 20, 2022
638bcfe
Update target_info.h
coder137 Jan 20, 2022
8a58fb8
Update target.h
coder137 Jan 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updated specialized toolchain documentation
  • Loading branch information
@coder137
coder137 committed Jan 18, 2022
commit 0fb0907aefd489d1f2c378656ea4bccca842eea8
10 changes: 10 additions & 0 deletions buildcc/toolchains/include/toolchains/toolchain_gcc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@

namespace buildcc {

/**
* @brief Generic GCC Toolchain <br>
* id = ToolchainId::Gcc <br>
* name = "gcc" <br>
* asm_compiler = "as" <br>
* c_compiler = "gcc" <br>
* cpp_compiler = "g++" <br>
* archiver = "ar" <br>
* linker = "ld" <br>
*/
class Toolchain_gcc : public Toolchain {
public:
Toolchain_gcc()
Expand Down
10 changes: 10 additions & 0 deletions buildcc/toolchains/include/toolchains/toolchain_mingw.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@

namespace buildcc {

/**
* @brief Generic MinGW Toolchain <br>
* id = ToolchainId::MinGW <br>
* name = "gcc" <br>
* asm_compiler = "as" <br>
* c_compiler = "gcc" <br>
* cpp_compiler = "g++" <br>
* archiver = "ar" <br>
* linker = "ld" <br>
*/
class Toolchain_mingw : public BaseToolchain {
public:
Toolchain_mingw()
Expand Down
10 changes: 10 additions & 0 deletions buildcc/toolchains/include/toolchains/toolchain_msvc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@

namespace buildcc {

/**
* @brief Generic GCC Toolchain <br>
* id = ToolchainId::Msvc <br>
* name = "msvc" <br>
* asm_compiler = "cl" <br>
* c_compiler = "cl" <br>
* cpp_compiler = "cl" <br>
* archiver = "lib" <br>
* linker = "link" <br>
*/
class Toolchain_msvc : public Toolchain {
public:
Toolchain_msvc()
Expand Down
27 changes: 26 additions & 1 deletion docs/source/user_api/toolchain.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Example
--------

.. code-block:: cpp

:linenos:

BaseToolchain custom_toolchain(ToolchainId::Custom, "custom_new_toolchain", "asm_compiler", "c_compiler", "cpp_compiler", "archiver", "linker");

std::vector<VerifiedToolchain> verified_toolchains = custom_toolchain.Verify();
Expand All @@ -35,5 +36,29 @@ Specialized Toolchain
toolchain_gcc.h
----------------

.. doxygenclass:: buildcc::Toolchain_gcc

toolchain_mingw.h
-----------------

.. doxygenclass:: buildcc::Toolchain_mingw

toolchain_msvc.h
-----------------

.. doxygenclass:: buildcc::Toolchain_msvc

Example
--------

.. code-block:: cpp
:linenos:

// Default GCC toolchain
Toolchain_gcc gcc;

// Default MinGW toolchain
Toolchain_mingw mingw;

// Default MSVC toolchain
Toolchain_msvc msvc;