Skip to content

Commit

Permalink
tutorials/cmake/commands: reformat table for larger command/descripti…
Browse files Browse the repository at this point in the history
…on column
  • Loading branch information
miconda committed Dec 11, 2024
1 parent fc94e96 commit 0588a1f
Showing 1 changed file with 31 additions and 12 deletions.
43 changes: 31 additions & 12 deletions docs/tutorials/cmake/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,34 @@ mkdir build
cd build
```

| Old-Makefiles | CMake | Description |
| :------------- | :------------ | :---------- |
| `make cfg` | `cmake ..` | Generate config files for the build system |
| `make PREFIX=/tmp/kamailio-dev cfg ` | `cmake -DCMAKE_INSTALL_PREFIX=/tmp/kamailio-dev ..` | Specify installation path prefix |
| `make include_modules="app_lua db_mysql" cfg` | `cmake -DINCLUDE_MODULES="app_lua db_mysql" ..` | Specify additional modules to be included in compilation |
| `make exclude_modules="app_lua db_mysql" cfg` | `cmake -DEXCLUDE_MODULES="app_lua db_mysql" ..` | Specify modules to be excluded from compilation |
| `make` | `make kamailio` | Compile `kamailio` binary (the core) |
| `make all` | `make` | Compile everything (core and modules) |
| `make modules modules=src/modules/acc` | `make acc` | Compile `acc` modules (substitute with any other module name) |
| `make Q=0` | `make VERBOSE=on` | Compile with verbose output (quiet off) |


Legend for the table:

- `OM` - Old-Makefiles

Check failure on line 25 in docs/tutorials/cmake/commands.md

View workflow job for this annotation

GitHub Actions / check-format

Unordered list indentation

docs/tutorials/cmake/commands.md:25:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md007.md
- `CM` - CMake

Check failure on line 26 in docs/tutorials/cmake/commands.md

View workflow job for this annotation

GitHub Actions / check-format

Unordered list indentation

docs/tutorials/cmake/commands.md:26:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md007.md

| Type | Description / Command |
| :--- | :--- |
| `---` | Generate config files for the build system |
| `OM` | `make cfg` |
| `CM` | `cmake ..` |
| `---` | Specify installation path prefix |
| `OM` | `make PREFIX=/tmp/kamailio-dev cfg` |
| `CM` | `cmake -DCMAKE_INSTALL_PREFIX=/tmp/kamailio-dev ..` |
| `---` | Specify additional modules to be included in compilation |
| `OM` | `make include_modules="app_lua db_mysql" cfg` |
| `CM` | `cmake -DINCLUDE_MODULES="app_lua db_mysql" ..` |
| `---` | Specify modules to be excluded from compilation |
| `OM` | `make exclude_modules="app_lua db_mysql" cfg` |
| `CM` | `cmake -DEXCLUDE_MODULES="app_lua db_mysql" ..` |
| `---` | Compile `kamailio` binary (the core) |
| `OM` | `make` |
| `CM` | `make kamailio` |
| `---` | Compile everything (core and modules) |
| `OM` | `make all` |
| `CM` | `make` |
| `---` | Compile `acc` modules (substitute with any other module name) |
| `OM` | `make modules modules=src/modules/acc` |
| `CM` | `make acc` |
| `---` | Compile with verbose output (quiet off) |
| `OM` | `make Q=0` |
| `CM` | `make VERBOSE=on` |

0 comments on commit 0588a1f

Please sign in to comment.