How to Include SVN Revision Number in Your Source Code

What is the best way to include the SVN revision number in my source code?

$Revision: 12345 $

Including the SVN revision number in your source code is crucial for version control as it helps developers track changes in the codebase. This process enables easier debugging and enhances collaboration among team members. Below is a detailed explanation of how to do this effectively.

// Example usage in C++:
const char* SVN_REVISION = "";
// This allows you to include the SVN revision number.

const char* svn_revision = "$Revision$"; // Automatically filled during SVN checkout.

Causes

• Manual version management is error-prone.
• Lack of traceability in shared codebases.
• Difficulty in identifying the exact version of code deployed in production.

Solutions

• Utilize the special SVN keywords like `$Revision$` in your comments or code files.
• Configure your SVN settings to automatically expand these keywords during checkouts or updates.
• Use a script to embed the revision number into build artifacts.

Mistake: Not enabling keyword expansion in SVN settings.

Solution: Ensure that the keyword expansion is set by configuring the properties of your files with the command `svn:keywords`.

Mistake: Hardcoding version numbers instead of using SVN integration.

Solution: Always rely on SVN keywords to keep track of the latest changes instead of manually updating version numbers.