mirror of
https://github.com/rizinorg/cutter.git
synced 2024-12-20 03:46:11 +00:00
Submodule update documentation (#2071)
* Add documentation to update the submodules (#2066) Co-authored-by: Itay Cohen <itaycohen23@gmail.com>
This commit is contained in:
parent
c93681649b
commit
4b0e3c6664
@ -276,4 +276,3 @@ The workaround is to either add the `--disable-new-dtags` linker flag when compi
|
|||||||
|
|
||||||
cmake -DCMAKE_EXE_LINKER_FLAGS="-Wl,--disable-new-dtags" ..
|
cmake -DCMAKE_EXE_LINKER_FLAGS="-Wl,--disable-new-dtags" ..
|
||||||
|
|
||||||
|
|
||||||
|
@ -177,3 +177,39 @@ Functions documentation
|
|||||||
~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
You can find the classes documentation in the API Reference menu item.
|
You can find the classes documentation in the API Reference menu item.
|
||||||
|
|
||||||
|
Updating the submodules
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Git submodules play a major part in Cutter. This, because Cutter is powered
|
||||||
|
by radare2, its parent project, and it tries to stay up-to-date with its
|
||||||
|
recent version, which allows us to implement new features, and enjoy bug
|
||||||
|
fixes and performance improvements on radare2. Often, we need to update
|
||||||
|
the radare2 submodule or others, in order to push the most recent
|
||||||
|
version of them to Cutter.
|
||||||
|
|
||||||
|
You can view the list of all the submodules from the cutter root folder with:
|
||||||
|
|
||||||
|
.. code:: sh
|
||||||
|
|
||||||
|
git config --file .gitmodules --get-regexp path | awk '{ print $2 }'
|
||||||
|
|
||||||
|
To update all the submodules at once, run these commands from the
|
||||||
|
cutter root folder:
|
||||||
|
|
||||||
|
.. code:: sh
|
||||||
|
|
||||||
|
git submodule foreach git pull origin master
|
||||||
|
git add submodule_name_1 submodule_name_2
|
||||||
|
git commit -m "Update submodules"
|
||||||
|
|
||||||
|
More likely, you'll only need to update the radare2 submodule.
|
||||||
|
In order to update one submodule individually, use the following code:
|
||||||
|
|
||||||
|
.. code:: sh
|
||||||
|
|
||||||
|
cd radare2
|
||||||
|
git checkout master && git pull
|
||||||
|
cd ..
|
||||||
|
git add radare2
|
||||||
|
git commit -m "Update radare2 submodule"
|
||||||
|
Loading…
Reference in New Issue
Block a user