Skip to content

Commit 8b38f43

Browse files
PXB-3440 [DOCS]Document how to build Pro build of PXB (#356)
modified: docs/compile-xtrabackup.md modified: docs/compile-xtrabackup.md
1 parent b026ee3 commit 8b38f43

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/compile-xtrabackup.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
<!--- are these instructions current?
2-
--->
3-
41
# Compile and install from source
52

63
The following instructions install Percona XtraBackup {{vers}}.
@@ -94,28 +91,33 @@ directory:
9491
$ cd build
9592
```
9693

97-
3. Run cmake or cmake3. In either case, the options you need to use are the
94+
3. If you use a regular build, run cmake or cmake3. In either case, the options you need to use are the
9895
same.
9996

10097
!!! note
10198

10299
You can build *Percona XtraBackup* with man pages but this requires
103100
`python-sphinx` package which isn’t available from that main repositories
104101
for every distribution. If you installed the `python-sphinx` package you
105-
need to remove the `-DWITH_MAN_PAGES=OFF` from previous command.
102+
need to remove the `-DWITH_MAN_PAGES=OFF` from the following command.
103+
104+
```{.bash data-prompt="$"}
105+
$ cmake -DBUILD_CONFIG=xtrabackup_release -DWITH_MAN_PAGES=OFF ..
106+
```
107+
108+
If you use [Pro builds](./pxb-pro.md), run the following command
106109

107110
```{.bash data-prompt="$"}
108-
$ cmake -DWITH_BOOST=PATH-TO-BOOST-LIBRARY -DDOWNLOAD_BOOST=ON \
109-
-DBUILD_CONFIG=xtrabackup_release -DWITH_MAN_PAGES=OFF -B ..
111+
$ cmake -DPROBUILD=1 -DBUILD_CONFIG=xtrabackup_release -DWITH_MAN_PAGES=OFF ..
110112
```
111113

112114
### Parameter Information
113115

114-
| **Parameter** | **Description** |
116+
| Parameter | Description |
115117
|---------------|-----------------|
116-
| `-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. |
117-
| `-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. |
118-
| `-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 (..). |
118+
| `-DPROBUILD=1` | This option enables a Pro build. |
119+
| `-DBUILD_CONFIG` | This option builds a release/optimized version of the xtrabackup binary. |
120+
| `-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. |
119121

120122
!!! important
121123

0 commit comments

Comments
 (0)