Skip to content

Commit 6b582c6

Browse files
authored
Removed all mentions of the Internal CMake Build Profile and update CMake preset names (#55)
* Remove references to internal build profile throughout the wiki * Update build profiles names throughout the wiki --------- Co-authored-by: Jaredl-Code <217964373+Jaredl-LV@users.noreply.github.com>
1 parent 321346d commit 6b582c6

File tree

6 files changed

+15
-47
lines changed

6 files changed

+15
-47
lines changed

SourceCode/Builds/build_configuration.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -41,25 +41,7 @@ There are four main build configurations in the project, each designed for diffe
4141

4242
- **Use Case:** Used during development for debugging and resolving issues in the code.
4343

44-
### 3. **Internal (O2, _INTERNAL)**
45-
46-
- **Purpose:** The internal configuration is used for internal development purposes, offering optimization and some
47-
debugging features to help developers while maintaining performance.
48-
- **Features:**
49-
- Combines optimization (`/O2`) for performance with limited debugging options.
50-
- Suitable for internal testing and development, where performance is important, but some debugging features are
51-
still needed.
52-
53-
- **Compiler Flags:**
54-
- `/O2`: Optimization for speed.
55-
- `/D "_INTERNAL"`: Defines the internal build configuration.
56-
- `/D "NDEBUG"`: Disables debugging in the final build.
57-
- `/Zi`: Generates debugging information.
58-
59-
- **Use Case:** Used for internal builds when developers need optimized performance but still want some debugging tools
60-
available.
61-
62-
### 4. **Profile (O2, IG_DEBUG_STACKTRACE, _RELEASE, _PROFILE)**
44+
### 3. **Profile (O2, IG_DEBUG_STACKTRACE, _RELEASE, _PROFILE)**
6345

6446
- **Purpose:** The profile configuration is used for performance profiling and optimization. It is designed to help
6547
developers analyze performance bottlenecks and gather performance data.
@@ -94,9 +76,7 @@ Below is a list of the key compiler flags used across different configurations:
9476
- **`/D "_DEBUG"`**: Defines the build as a debug version, enabling debugging-specific features in the code.
9577
- **`/D "_RELEASE"`**: Defines the build as a release version, disabling debugging features and optimizing for
9678
performance.
97-
- **`/D "_INTERNAL"`**: Marks the build as an internal version, which may include some debugging information while still
98-
being optimized for performance.
99-
- **`/D "NDEBUG"`**: Disables debugging code, typically used in release and internal builds.
79+
- **`/D "NDEBUG"`**: Disables debugging code, typically used in release builds.
10080

10181
### Profiling Flags
10282

@@ -121,7 +101,5 @@ Below is a list of the key compiler flags used across different configurations:
121101
is optimized for performance with no debugging overhead.
122102
- **Debug:** Use this configuration during development when you need to debug issues. It disables optimizations and
123103
includes debugging information.
124-
- **Internal:** Use this configuration for internal builds where you need some debugging features but still require
125-
optimized performance.
126104
- **Profile:** Use this configuration when analyzing the performance of the game. It helps identify bottlenecks and
127105
areas that can be optimized further.

SourceCode/Builds/build_guides.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,11 @@ guides cover different environments, configurations, and setups for building the
77
## Build Configurations Overview
88

99
Before diving into the build guides, it's important to understand the different build configurations used in the
10-
project. These configurations dictate how the project is built, whether for debugging, profiling, release, or internal
11-
development purposes. Some common configurations include:
10+
project. These configurations dictate how the project is built, whether for debugging, profiling or release.
1211

1312
- **Release:** Optimized for end-users, providing a smaller, faster executable with no debugging information.
1413
- **Debug:** Includes debugging information, making it easier to trace and debug the code, but without optimization to
1514
ensure ease of debugging.
16-
- **Internal:** Includes debugging information and optimizations, used primarily by developers for testing and internal
17-
purposes.
1815
- **Profile:** Used for performance profiling, with optimizations enabled and additional debugging options to collect
1916
profiling data.
2017

SourceCode/Builds/build_with_clion_vc6_toolchain.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ compatibility with the original compiler from the game's development era. To com
5454
1. In the CMake profiles, enable the profiles you want to use. The available workflow presets are:
5555
- `vc6` - Release build
5656
- `vc6-debug` - Debug build
57-
- `vc6-internal` - Internal build
5857
- `vc6-profile` - Profile build
5958
6059
For detailed information about each build configuration and their specific purposes, see the [Build Configurations Overview](https://github.com/TheSuperHackers/GeneralsGameCode/wiki/build_configuration).

SourceCode/Builds/build_with_msvc22.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,9 @@ For build using solutions and more advanced build configurations, see below.
4343
- Select the appropriate build configuration:
4444
- `Build Windows 32bit Release` for a release build.
4545
- `Build Windows 32bit Debug` for a debug build.
46-
- `Build Windows 32bit Internal` for an internal build.
4746
- `Build Windows 32bit Profile` for a profile build.
4847
- `Build Windows 32bit VCPKG Release` for a release build with the VCPKG package manager.
4948
- `Build Windows 32bit VCPKG Debug` for a debug build with the VCPKG package manager.
50-
- `Build Windows 32bit VCPKG Internal` for an internal build with the VCPKG package manager.
5149
- `Build Windows 32bit VCPKG Profile` for a profile build with the VCPKG package manager.
5250

5351
![Build options](https://github.com/TheSuperHackers/GeneralsWiki/raw/refs/heads/main/SourceCode/Builds/files/buildoptions.jpg)
@@ -63,7 +61,7 @@ page.
6361
![image](https://github.com/user-attachments/assets/37d59b79-77fc-4797-bbab-be385dd654da)
6462

6563
- Build the project by clicking on the `Build` menu and selecting `Build`.
66-
- The compiled executable will be placed in the build folder. Example: `build/win32dgb/GeneralsMD/Debug`
64+
- The compiled executable will be placed in the build folder. Example: `build/win32-debug/GeneralsMD/Debug`
6765
- Install the game executable in the game directory by clicking on the `Install` in `Build` menu. This will copy the
6866
executable to the retail game directory.
6967

@@ -107,17 +105,16 @@ to build the project from the command line.
107105
- #### 2. **Development and Debug Builds**
108106

109107
- **Choose the build configuration:**
110-
- `cmake --workflow --preset win32dgb` for Debug build.
111-
- `cmake --workflow --preset win32int` for Internal build.
112-
- `cmake --workflow --preset win32prof` for Profile build.
108+
- `cmake --workflow --preset win32-debug` for Debug build.
109+
- `cmake --workflow --preset win32-profile` for Profile build.
113110

114111
- **Install the game executable in the game directory (assuming the build was successful):**
115112
- `cmake --install build/<preset name>`
116113

117114
- **To build a specific target:**
118115
- Run `cmake --build build/<preset name> --target <target name>`
119-
- Example: `cmake --build build/win32dgb --target z_generals`
120-
- Or: `cmake --build build/win32int --target g_generals`
116+
- Example: `cmake --build build/win32-debug --target z_generals`
117+
- Or: `cmake --build build/win32-profile --target g_generals`
121118

122119
For more CMake options, see the [CMake Guide](cmake_guide).
123120

SourceCode/Builds/build_with_msvc6.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,6 @@ Run the following command based on the type of build you want to create:
119119

120120
- `cmake --workflow --preset vc6` for a release build.
121121
- `cmake --workflow --preset vc6-debug` for a debug build.
122-
- `cmake --workflow --preset vc6-internal` for an internal build.
123122
- `cmake --workflow --preset vc6-profile` for a profile build.
124123

125124
You will find a bunch of files in `build\vc6\<game name>` and a file called `generalszh.exe` or `generalsv.exe`.

SourceCode/Builds/cmake_guide.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,14 @@ The **preset** defines the predefined build configuration. The available presets
2828
### For Visual Studio 2022 or Ninja
2929

3030
- `win32`: Release build.
31-
- `win32dgb`: Debug build.
32-
- `win32int`: Internal build.
33-
- `win32prof`: Profile build.
31+
- `win32-debug`: Debug build.
32+
- `win32-profile`: Profile build.
3433

3534
### For Visual Studio 6
3635

3736
- `vc6`: Release build.
38-
- `vc6dgb`: Debug build.
39-
- `vc6int`: Internal build.
40-
- `vc6prof`: Profile build.
37+
- `vc6-debug`: Debug build.
38+
- `vc6-profile`: Profile build.
4139

4240
### Usage
4341

@@ -196,13 +194,13 @@ To build the Zero Hour code along with its tools in debug mode, use the followin
196194

197195
```bash
198196
# Step 1: Configure the build with a preset and additional options
199-
cmake --preset win32dgb -DGENZH_BUILD_ZEROHOUR=ON -DGENZH_BUILD_ZEROHOUR_TOOLS=ON
197+
cmake --preset win32-debug -DGENZH_BUILD_ZEROHOUR=ON -DGENZH_BUILD_ZEROHOUR_TOOLS=ON
200198

201199
# Step 2: Build the project
202-
cmake --build build/win32dbg
200+
cmake --build build/win32-debug
203201

204202
# Step 3: Install the project to the default installation path
205-
cmake --install build/win32dbg
203+
cmake --install build/win32-debug
206204
```
207205
<!-- markdownlint-disable-next-line -->
208206
### **Build Only World Builder Tool:**

0 commit comments

Comments
 (0)