khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2025-12-12 07:29:47 +07:00
Code Issues Packages Projects Releases Wiki Activity

docs(admin_manual) reorder “Patching Nextcloud” for logical flow

Browse Source 
- Move “Getting a patch from a GitHub pull request” section before applying steps and rename it to “Obtaining a patch”
- Add “Notes and troubleshooting” section
- Improve grammar, punctuation, and phrasing
- Clarify backport guidance + include actual backport PR/URLs
- Fix randomly cut-off sentence in the error Note

Signed-off-by: Josh <josh.t.richards@gmail.com>
This commit is contained in:
Josh
2025-11-17 09:45:16 -05:00
committed by GitHub
parent 8f721bbb4f
commit 0932f3afef
1 changed files with 24 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
admin_manual/issues/applying_patch.rst
View File

@@ -2,46 +2,49 @@
Patching Nextcloud
==================
Obtaining a patch
-----------------
If you found a related pull request on GitHub that solves your issue, or you want to help developers and verify a fix works, you can get a patch for the pull request.
1. Using https://github.com/nextcloud/server/pull/26396 as an example.
2. Append ``.patch`` to the URL: https://github.com/nextcloud/server/pull/26396.patch
3. Download the patch to your server and follow the `Applying a patch`_ steps.
4. If you are on an older Nextcloud version, you might first need to go to the correct backported patch for your version.
.. image:: images/getting-a-patch-from-github.png
:alt: backportbot-nextcloud linking to the pull request for an older version.
5. You can find the appropriate version by looking for a link posted by ``backportbot-nextcloud`` to the backport pull request for your release, or by checking for a developer comment with a manual backport link. Use the ``.patch`` URL of that backport PR.
Applying a patch
----------------
Patching server
^^^^^^^^^^^^^^^
1. Navigate into your Nextcloud server's root directory (contains the ``status.php`` file)
2. Now apply the patch with the following command::
1. Navigate to your Nextcloud server's root directory (the one that contains the ``status.php`` file).
2. Apply the patch with the following command::
patch -p 1 < /path/to/the/file.patch
.. note::
There can be errors about not found files, especially when you take a patch from GitHub there might be development or test files included in the patch. when the files are in build/ or a tests/ subdirectory it is mostly being
Patching apps
^^^^^^^^^^^^^
1. Navigate to the root of this app (mostly ``apps/[APPID]/``), if you can not find the app there use the ``sudo -E -u www-data php occ app:getpath APPID`` command to find the path.
2. Now apply the patch with the same command as in `Patching server`_
1. Navigate to the root of the app (usually ``apps/[APPID]/``). If you cannot find the app there, use the ``sudo -E -u www-data php occ app:getpath APPID`` command to find the path.
2. Apply the patch with the same command as in `Patching server`_.
Reverting a patch
-----------------
1. Navigate to the directory where you applied the patch.
2. Now revert the patch with the ``-R`` option::
2. Revert the patch with the ``-R`` option::
patch -R -p 1 < /path/to/the/file.patch
Getting a patch from a GitHub pull request
------------------------------------------
Notes and troubleshooting
-------------------------
If you found a related pull request on GitHub that solves your issue, or you want to help developers and verify a fix works, you can get a patch for the pull request.
.. note::
1. Using https://github.com/nextcloud/server/pull/26396 as an example.
2. Append ``.patch`` to the URL: https://github.com/nextcloud/server/pull/26396.patch
3. Download the patch to your server and follow the `Applying a patch`_ steps.
4. In case you are on an older version, you might first need to go the the correct version of the patch.
.. image:: images/getting-a-patch-from-github.png
:alt: backportbot-nextcloud linking to the pull request for an older version.
5. You can find it by looking for a link by the ``backportbot-nextcloud`` or a developer will leave a manual comment about the backport to an older Nextcloud version. For the example above you the pull request for Nextcloud 21 is at https://github.com/nextcloud/server/pull/26406 and the patch at https://github.com/nextcloud/server/pull/26406.patch
You may see errors about files not being found, especially when applying patches from GitHub. Patches can include development or test files (for example, files under ``build/`` or ``tests/``) that are not present on your installation. These messages are expected and can be ignored if they refer only to such files.