Visible properties

Visible properties. More...

Modules
	Meta-data properties
	Meta-data properties.
Defines
#define	SVN_PROP_BOOLEAN_TRUE   "*"
	Properties whose values are interpreted as booleans (such as svn:executable, svn:needs_lock, and svn:special) always fold their value to this.
#define	SVN_PROP_MIME_TYPE   SVN_PROP_PREFIX "mime-type"
	The mime-type of a given file.
#define	SVN_PROP_IGNORE   SVN_PROP_PREFIX "ignore"
	The ignore patterns for a given directory.
#define	SVN_PROP_EOL_STYLE   SVN_PROP_PREFIX "eol-style"
	The line ending style for a given file.
#define	SVN_PROP_KEYWORDS   SVN_PROP_PREFIX "keywords"
	The "activated" keywords (for keyword substitution) for a given file.
#define	SVN_PROP_EXECUTABLE   SVN_PROP_PREFIX "executable"
	Set to either TRUE or FALSE if we want a file to be executable or not.
#define	SVN_PROP_EXECUTABLE_VALUE   SVN_PROP_BOOLEAN_TRUE
	The value to force the executable property to when set.
#define	SVN_PROP_NEEDS_LOCK   SVN_PROP_PREFIX "needs-lock"
	Set to TRUE ('*') if we want a file to be set to read-only when not locked.
#define	SVN_PROP_NEEDS_LOCK_VALUE   SVN_PROP_BOOLEAN_TRUE
	The value to force the needs-lock property to when set.
#define	SVN_PROP_SPECIAL   SVN_PROP_PREFIX "special"
	Set if the file should be treated as a special file.
#define	SVN_PROP_SPECIAL_VALUE   SVN_PROP_BOOLEAN_TRUE
	The value to force the special property to when set.
#define	SVN_PROP_EXTERNALS   SVN_PROP_PREFIX "externals"
	Describes external items to check out into this directory.
#define	SVN_PROP_MERGEINFO   SVN_PROP_PREFIX "mergeinfo"
	Merge info property used to record a resource's merge history.

---

Detailed Description

Visible properties.

These are regular properties that are attached to ordinary files and dirs, and are visible (and tweakable) by svn client programs and users. Adding these properties causes specific effects.

Note:

the values of these properties are always UTF8-encoded with LF line-endings. It is the burden of svn library users to enforce this. Use svn_prop_needs_translation() to discover if a certain property needs translation, and you can use svn_subst_translate_string()/svn_subst_detranslate_string() to do the translation.

---

Define Documentation

#define SVN_PROP_BOOLEAN_TRUE   "*"

Properties whose values are interpreted as booleans (such as svn:executable, svn:needs_lock, and svn:special) always fold their value to this.

Since:

New in 1.5.

Definition at line 286 of file svn_props.h.

#define SVN_PROP_EOL_STYLE   SVN_PROP_PREFIX "eol-style"

The line ending style for a given file.

Definition at line 295 of file svn_props.h.

#define SVN_PROP_EXECUTABLE   SVN_PROP_PREFIX "executable"

Set to either TRUE or FALSE if we want a file to be executable or not.

Definition at line 301 of file svn_props.h.

#define SVN_PROP_EXECUTABLE_VALUE   SVN_PROP_BOOLEAN_TRUE

The value to force the executable property to when set.

Deprecated:

Provided for backward compatibility with the 1.4 API. Use SVN_PROP_BOOLEAN_TRUE instead.

Definition at line 308 of file svn_props.h.

#define SVN_PROP_EXTERNALS   SVN_PROP_PREFIX "externals"

Describes external items to check out into this directory.

The format is a series of lines, such as:

     localdir1           http://url.for.external.source/etc/
     localdir1/foo       http://url.for.external.source/foo
     localdir1/bar       http://blah.blah.blah/repositories/theirproj
     localdir1/bar/baz   http://blorg.blorg.blorg/basement/code
     localdir2           http://another.url/blah/blah/blah
     localdir3           http://and.so.on/and/so/forth 

The subdir names on the left side are relative to the directory on which this property is set.

Definition at line 347 of file svn_props.h.

#define SVN_PROP_IGNORE   SVN_PROP_PREFIX "ignore"

The ignore patterns for a given directory.

Definition at line 292 of file svn_props.h.

#define SVN_PROP_KEYWORDS   SVN_PROP_PREFIX "keywords"

The "activated" keywords (for keyword substitution) for a given file.

Definition at line 298 of file svn_props.h.

#define SVN_PROP_MERGEINFO   SVN_PROP_PREFIX "mergeinfo"

Merge info property used to record a resource's merge history.

The format is a series of lines containing merge paths and revision ranges, such as:

     /trunk: 1-6,9,37-38
     /trunk/foo: 10 

Definition at line 358 of file svn_props.h.

#define SVN_PROP_MIME_TYPE   SVN_PROP_PREFIX "mime-type"

The mime-type of a given file.

Definition at line 289 of file svn_props.h.

#define SVN_PROP_NEEDS_LOCK   SVN_PROP_PREFIX "needs-lock"

Set to TRUE ('*') if we want a file to be set to read-only when not locked.

FALSE is indicated by deleting the property.

Definition at line 312 of file svn_props.h.

#define SVN_PROP_NEEDS_LOCK_VALUE   SVN_PROP_BOOLEAN_TRUE

The value to force the needs-lock property to when set.

Deprecated:

Provided for backward compatibility with the 1.4 API. Use SVN_PROP_BOOLEAN_TRUE instead.

Definition at line 319 of file svn_props.h.

#define SVN_PROP_SPECIAL   SVN_PROP_PREFIX "special"

Set if the file should be treated as a special file.

Definition at line 322 of file svn_props.h.

#define SVN_PROP_SPECIAL_VALUE   SVN_PROP_BOOLEAN_TRUE

The value to force the special property to when set.

Deprecated:

Provided for backward compatibility with the 1.4 API. Use SVN_PROP_BOOLEAN_TRUE instead.

Definition at line 329 of file svn_props.h.