Subversion
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Modules | Macros
Visible properties
Properties management utilities

Visible properties. More...

Modules

 Meta-data properties
 Meta-data properties.
 

Macros

#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.
 
#define SVN_PROP_INHERITABLE_AUTO_PROPS   SVN_PROP_PREFIX "auto-props"
 Property used to record inheritable configuration auto-props.
 
#define SVN_PROP_INHERITABLE_IGNORES   SVN_PROP_PREFIX "global-ignores"
 Property used to record inheritable configuration ignores.
 
#define SVN_PROP_NODE_ALL_PROPS
 This is a list of all user-visible and -settable versioned node properties.
 

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.

Macro Definition 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 370 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 379 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 385 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 392 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, each in the following format: [-r REV] URL[] LOCALPATH LOCALPATH is relative to the directory having this property. REV pins the external to revision REV. URL may be a full URL or a relative URL starting with one of: ../ to the parent directory of the extracted external ^/ to the repository root / to the server root // to the URL scheme The following format is supported for interoperability with Subversion 1.4 and earlier clients: LOCALPATH [-r PEG] URL The ambiguous format 'relative_path relative_path' is taken as 'relative_url relative_path' with peg revision support. Lines starting with a '#' character are ignored.

Definition at line 433 of file svn_props.h.

#define SVN_PROP_IGNORE   SVN_PROP_PREFIX "ignore"

The ignore patterns for a given directory.

Definition at line 376 of file svn_props.h.

#define SVN_PROP_INHERITABLE_AUTO_PROPS   SVN_PROP_PREFIX "auto-props"

Property used to record inheritable configuration auto-props.

Since
New in 1.8.

Definition at line 451 of file svn_props.h.

#define SVN_PROP_INHERITABLE_IGNORES   SVN_PROP_PREFIX "global-ignores"

Property used to record inheritable configuration ignores.

Since
New in 1.8.

Definition at line 457 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 382 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 
Since
New in 1.5.

Definition at line 445 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 373 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 396 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 403 of file svn_props.h.

#define SVN_PROP_NODE_ALL_PROPS
Value:
SVN_PROP_IGNORE, \
SVN_PROP_EOL_STYLE, \
SVN_PROP_KEYWORDS, \
SVN_PROP_EXECUTABLE, \
SVN_PROP_NEEDS_LOCK, \
SVN_PROP_SPECIAL, \
SVN_PROP_EXTERNALS, \
SVN_PROP_MERGEINFO, \
SVN_PROP_INHERITABLE_AUTO_PROPS, \
SVN_PROP_INHERITABLE_IGNORES, \
\
SVN_PROP_TEXT_TIME, \
SVN_PROP_OWNER, \
SVN_PROP_GROUP, \
SVN_PROP_UNIX_MODE,

This is a list of all user-visible and -settable versioned node properties.

Since
New in 1.8.

Definition at line 504 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 406 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 413 of file svn_props.h.