Skip to content

Commit 674c87d

Browse files
author
Ryan Roden-Corrent
committed
Better document ways to set config search.
Add <seealso> references in the docs between GitRepositoryOptions and GlobalSettings.SetConfigSearchPaths.
1 parent 3b23c36 commit 674c87d

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

LibGit2Sharp/GlobalSettings.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,8 @@ public static IEnumerable<string> GetConfigSearchPaths(ConfigurationLevel level)
286286

287287
/// <summary>
288288
/// Set the paths under which libgit2 searches for the configuration file of a given level.
289+
///
290+
/// <seealso cref="RepositoryOptions"/>.
289291
/// </summary>
290292
/// <param name="level">The level (global/system/XDG) of the config.</param>
291293
/// <param name="paths">

LibGit2Sharp/RepositoryOptions.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ public sealed class RepositoryOptions
3232
/// The path has either to lead to an existing valid configuration file,
3333
/// or to a non existent configuration file which will be eventually created.
3434
/// </para>
35+
/// <seealso cref="GlobalSettings.SetConfigSearchPaths"/>.
3536
/// </summary>
3637
public string GlobalConfigurationLocation { get; set; }
3738

@@ -41,6 +42,7 @@ public sealed class RepositoryOptions
4142
/// The path has either to lead to an existing valid configuration file,
4243
/// or to a non existent configuration file which will be eventually created.
4344
/// </para>
45+
/// <seealso cref="GlobalSettings.SetConfigSearchPaths"/>.
4446
/// </summary>
4547
public string XdgConfigurationLocation { get; set; }
4648

@@ -50,6 +52,7 @@ public sealed class RepositoryOptions
5052
/// The path has to lead to an existing valid configuration file,
5153
/// or to a non existent configuration file which will be eventually created.
5254
/// </para>
55+
/// <seealso cref="GlobalSettings.SetConfigSearchPaths"/>.
5356
/// </summary>
5457
public string SystemConfigurationLocation { get; set; }
5558

0 commit comments

Comments
 (0)