From 551134a93576fbd71bc087f4e949317a93063576 Mon Sep 17 00:00:00 2001 From: Patrick Donnelly Date: Tue, 6 Apr 2021 06:58:13 -0700 Subject: [PATCH] doc: update some docs still referring to make We use ninja now. Signed-off-by: Patrick Donnelly --- doc/dev/developer_guide/basic-workflow.rst | 2 +- doc/dev/developer_guide/essentials.rst | 2 +- doc/dev/quick_guide.rst | 38 ++++++++++++++++------ 3 files changed, 30 insertions(+), 12 deletions(-) diff --git a/doc/dev/developer_guide/basic-workflow.rst b/doc/dev/developer_guide/basic-workflow.rst index 5b7c228dab680..9fb2ba2c44e2e 100644 --- a/doc/dev/developer_guide/basic-workflow.rst +++ b/doc/dev/developer_guide/basic-workflow.rst @@ -15,7 +15,7 @@ The following chart illustrates the basic Ceph development workflow: | git merge | | v /----------------\ git commit --amend /-------------\ - | make check |---------------------> | ceph/fix_1 | + | ninja check |---------------------> | ceph/fix_1 | | ceph--qa--suite| \-------------/ \----------------/ | ^ | fix changes diff --git a/doc/dev/developer_guide/essentials.rst b/doc/dev/developer_guide/essentials.rst index 94367a809a936..ad3604966ae34 100644 --- a/doc/dev/developer_guide/essentials.rst +++ b/doc/dev/developer_guide/essentials.rst @@ -180,7 +180,7 @@ Cleaning the Source Tree .. prompt:: bash $ - make clean + ninja clean .. note:: The following commands will remove everything in the source tree that isn't tracked by git. Make sure to back up your log files diff --git a/doc/dev/quick_guide.rst b/doc/dev/quick_guide.rst index 8e27dfb4b714e..e78a023d3779a 100644 --- a/doc/dev/quick_guide.rst +++ b/doc/dev/quick_guide.rst @@ -25,23 +25,42 @@ Example: ./install-deps.sh ./do_cmake.sh -DWITH_MANPAGE=OFF -DWITH_BABELTRACE=OFF -DWITH_MGR_DASHBOARD_FRONTEND=OFF +You can also turn off building of some core components that are not relevant to +your development: + +.. prompt:: bash $ + + ./do_cmake.sh ... -DWITH_RBD=OFF -DWITH_KRBD=OFF -DWITH_RADOSGW=OFF + +Finally, build ceph: + +.. prompt:: bash $ + + cmake --build build [--target ...] + +Omit ``--target...`` if you want to do a full build. + + Running a development deployment -------------------------------- -Ceph contains a script called ``vstart.sh`` (see also :doc:`/dev/dev_cluster_deployement`) which allows developers to quickly test their code using -a simple deployment on your development system. Once the build finishes successfully, start the ceph -deployment using the following command: + +Ceph contains a script called ``vstart.sh`` (see also +:doc:`/dev/dev_cluster_deployement`) which allows developers to quickly test +their code using a simple deployment on your development system. Once the build +finishes successfully, start the ceph deployment using the following command: .. prompt:: bash $ - cd ceph/build # Assuming this is where you ran cmake - make vstart - ../src/vstart.sh -d -n -x + cd build + ../src/vstart.sh -d -n You can also configure ``vstart.sh`` to use only one monitor and one metadata server by using the following: .. prompt:: bash $ - MON=1 MDS=1 ../src/vstart.sh -d -n -x + env MON=1 MDS=1 ../src/vstart.sh -d -n -x + +Most logs from the cluster can be found in ``build/out``. The system creates two pools on startup: `cephfs_data_a` and `cephfs_metadata_a`. Let's get some stats on the current pools: @@ -108,7 +127,7 @@ you might do something like this: ../src/stop.sh rm -rf out dev - MDS=1 MON=1 OSD=3 ../src/vstart.sh -n -d + env MDS=1 MON=1 OSD=3 ../src/vstart.sh -n -d Running a RadosGW development environment ----------------------------------------- @@ -136,5 +155,4 @@ The tests are located in `src/tests`. To run them type: .. prompt:: bash $ - make check - + (cd build && ninja check) -- 2.39.5