diff options
author | James McCoy <jamessan@debian.org> | 2019-11-16 13:05:42 -0500 |
---|---|---|
committer | James McCoy <jamessan@debian.org> | 2019-11-16 13:05:42 -0500 |
commit | ff0dcb36b05eb662b51423774a4502bc04378f69 (patch) | |
tree | 0839f9b4a052f41206aebfed0c08b2b832621638 /doc | |
parent | 569b75c031bd32d4ee16874ecdf225adac62514d (diff) |
New upstream version 1.13.0
Diffstat (limited to 'doc')
-rw-r--r-- | doc/doxygen.conf | 59 | ||||
-rw-r--r-- | doc/programmer/gtest-guide.txt | 30 | ||||
-rw-r--r-- | doc/user/svn-best-practices.html | 2 |
3 files changed, 10 insertions, 81 deletions
diff --git a/doc/doxygen.conf b/doc/doxygen.conf index adb7efb..b66d5ba 100644 --- a/doc/doxygen.conf +++ b/doc/doxygen.conf @@ -112,7 +112,7 @@ INLINE_INHERITED_MEMB = NO # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. -FULL_PATH_NAMES = NO +FULL_PATH_NAMES = YES # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is @@ -121,7 +121,7 @@ FULL_PATH_NAMES = NO # If left blank the directory from which doxygen is run is used as the # path to strip. -STRIP_FROM_PATH = +STRIP_FROM_PATH = subversion/include subversion/bindings/cxx/include # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells @@ -130,7 +130,7 @@ STRIP_FROM_PATH = # definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = subversion/include subversion/bindings/cxx/include # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful is your file systems @@ -280,22 +280,6 @@ SUBGROUPING = YES TYPEDEF_HIDES_STRUCT = NO -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penality. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will rougly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols - -SYMBOL_CACHE_SIZE = 0 - #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -478,12 +462,6 @@ MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - # Set the SHOW_FILES tag to NO to disable the generation of the Files page. # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. @@ -577,6 +555,10 @@ WARN_LOGFILE = # with spaces. INPUT = subversion/include \ + subversion/bindings/cxx/include \ + subversion/bindings/cxx/include/svnxx \ + subversion/bindings/cxx/include/svnxx/client \ + subversion/bindings/cxx/include/svnxx/detail \ subversion/include/private/svn_doxygen.h # This tag can be used to specify the character encoding of the source files @@ -594,7 +576,7 @@ INPUT_ENCODING = UTF-8 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 -FILE_PATTERNS = *.h +FILE_PATTERNS = *.h *.hpp # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -805,12 +787,6 @@ HTML_FOOTER = HTML_STYLESHEET = -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports @@ -959,11 +935,6 @@ ENUM_VALUES_PER_LINE = 1 GENERATE_TREEVIEW = NO -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. - -USE_INLINE_TREES = NO - # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. @@ -1151,18 +1122,6 @@ GENERATE_XML = NO XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that @@ -1378,7 +1337,7 @@ HAVE_DOT = NO # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory # containing the font. -DOT_FONTNAME = FreeSans +DOT_FONTNAME = # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt. diff --git a/doc/programmer/gtest-guide.txt b/doc/programmer/gtest-guide.txt deleted file mode 100644 index 225690c..0000000 --- a/doc/programmer/gtest-guide.txt +++ /dev/null @@ -1,30 +0,0 @@ -Googlemock and Googletest Suite for Subversion ---------------------------------------------- - -Googlemock and Googletest are external packages that are downloaded -and compiled on request, as part of regular compilations. - -Googlemock is available here: - - https://code.google.com/p/googlemock/ - -The source packages already include Googletest, which is available -here: - - https://code.google.com/p/googletest/ - -Subversion uses Googlemock and Googletest for the C++HL test suite. - - - -To configure Subversion to use Googlemock, type - - ./get-dep.sh gmock - -This will download Googlemock and put the fused source into the -'gmock-fused' directory. Once it's there, configure will pick it up -automatically (but you do have to re-run autogen.sh and configure). - -You can disable building Googlemock (and hence the C++HL test suite) -with the --disable-gmock configure option. This will tell configure to -ignore the gmock-fused directory. diff --git a/doc/user/svn-best-practices.html b/doc/user/svn-best-practices.html index b168786..8bfa495 100644 --- a/doc/user/svn-best-practices.html +++ b/doc/user/svn-best-practices.html @@ -240,7 +240,7 @@ while somebody else is in the process of committing.</p> <li>Users commit their day-to-day work on <tt>/trunk</tt>.</li> <li>Rule #1: <tt>/trunk</tt> must compile and pass regression tests at -all times. Committers who violate this rule are publically +all times. Committers who violate this rule are publicly humiliated.</li> <li>Rule #2: a single commit (changeset) must not be so large |