Patch & Commit

Submit Patches

The first few times you make changes to the manual, you will need to submit them as patches for an administrator to review. This is just to make sure that we maintain a quality user manual, and that you do not accidentally break anything vital before you get used to the system.

In order to submit a patch, follow this process:

  1. Make any changes that you want.

  2. Create a patch file by running:

    svn diff > filename.diff

    This creates a simple text file that shows what text was added, removed or changed between your working files and the central repository.

    If you have created or deleted files, you will need to run svn add /path/to/file or svn rm /path/to/file before creating the diff. To see a list of affected files, run svn status.

  3. Upload the diff file here. If you do not have an account already, you can register for one.

  4. After submitting the diff, you will be asked to "Create a new Revision" before you can add a title and description of your changes.

  5. Please check if the Documentation project is assigned in the tag's field in order to notify the team of your patch. You can also contact the team over the mailing list or Blender Chat.

  6. They will review your patch and let you know about any changes you could make. If there is no issue, your patch will be accepted and then committed by the team of your patch.

Note

If your patch includes changes to or additional images, simply attach them when you are creating the revision.

Straightforward patches are bound to be accepted very quickly. Once you get accustomed to making changes and no longer need feedback, we cut out the middle man and give you direct access to edit the manual.

See also

See Release Cycle for documentation on how to make commits to a specific release branch and how to create merge commits.

Commit Directly

Once you are provided with the direct access to edit the manual, you can start committing directly instead of creating a patch file. Doing this will submit the change directly to our central repository.

All you need to do now is run:

svn commit -m "This is what I did"

如果你省略了 -m "message"，将提示你在文本编辑器中输入留言。

Do not forget to always run svn update before committing.

Then you will be asked for your username and password (from developer.blender.org) before the change is committed.

Note

Make sure to use your username (case sensitive) and not your email.

Your modified files are uploaded to the central repository for others to work with and continue collaborating. Commits are tracked in the repositories Diffusion. Soon after your changes become visible in the online manual.

写一个好的承诺信息

当对手册进行与 Blender 中的特定提交（更改）直接相关的更改时，将提交标题与提交给 Blender 的标题相同很有帮助。要求您包含对 Blender 源代码所做的提交的提交哈希。

例如，提交 rBM8473 包括指示与散列 rBa71d2b260170 一起做出的改变的描述性说明。可以从文档任务中为即将发布的特定版本提供的 URL 中提取哈希。

其他更一般的变更不必遵循上述政策，但仍有必要明确说明您所做的变更及其原因。当您分别进行常规清理或修复时，使用前缀词（如 Cleanup: 或 Fix:）来前缀提交标题可能会有所帮助。

编写好的提交消息有助于管理员跟踪所做的更改，并确保所有新功能都得到正确记录。