Skip to content

Commit

Permalink
PXB-3440 [DOCS]Document how to build Pro build of PXB (#356)
Browse files Browse the repository at this point in the history
modified:   docs/compile-xtrabackup.md
modified:   docs/compile-xtrabackup.md
  • Loading branch information
alina-derkach-oaza authored Jan 31, 2025
1 parent b026ee3 commit 8b38f43
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions docs/compile-xtrabackup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
<!--- are these instructions current?
--->

# Compile and install from source

The following instructions install Percona XtraBackup {{vers}}.
Expand Down Expand Up @@ -94,28 +91,33 @@ directory:
$ cd build
```

3. Run cmake or cmake3. In either case, the options you need to use are the
3. If you use a regular build, run cmake or cmake3. In either case, the options you need to use are the
same.

!!! note

You can build *Percona XtraBackup* with man pages but this requires
`python-sphinx` package which isn’t available from that main repositories
for every distribution. If you installed the `python-sphinx` package you
need to remove the `-DWITH_MAN_PAGES=OFF` from previous command.
need to remove the `-DWITH_MAN_PAGES=OFF` from the following command.

```{.bash data-prompt="$"}
$ cmake -DBUILD_CONFIG=xtrabackup_release -DWITH_MAN_PAGES=OFF ..
```

If you use [Pro builds](./pxb-pro.md), run the following command

```{.bash data-prompt="$"}
$ cmake -DWITH_BOOST=PATH-TO-BOOST-LIBRARY -DDOWNLOAD_BOOST=ON \
-DBUILD_CONFIG=xtrabackup_release -DWITH_MAN_PAGES=OFF -B ..
$ cmake -DPROBUILD=1 -DBUILD_CONFIG=xtrabackup_release -DWITH_MAN_PAGES=OFF ..
```

### Parameter Information

| **Parameter** | **Description** |
| Parameter | Description |
|---------------|-----------------|
| `-DWITH_BOOST` | For the `-DWITH_BOOST` parameter, specify the name of a directory to download the boost library to. This directory is created automatically in your current directory. |
| `-DWITH_MAN_PAGES` | To build **Percona XtraBackup** man pages, use `ON` or remove this parameter from the command line (it is `ON` by default). To install the man pages, install the python3-sphinx package first. |
| `-B` (--build)| **Percona XtraBackup** is configured to forbid generating the build pipeline for make in the same directory where you store your sources. The `-B` parameter refers to the directory that contains the source code. In this example, we use the relative path to the parent directory (..). |
| `-DPROBUILD=1` | This option enables a Pro build. |
| `-DBUILD_CONFIG` | This option builds a release/optimized version of the xtrabackup binary. |
| `-DWITH_MAN_PAGES` | To build Percona XtraBackup man pages, use `ON` or remove this parameter from the command line (it is `ON` by default). To install the man pages, install the python3-sphinx package first. |

!!! important

Expand Down

0 comments on commit 8b38f43

Please sign in to comment.