Update docs

This commit is contained in:
Dawa Ometto
2020-03-29 22:28:23 +02:00
parent 6a1ea82ff1
commit f0bb300e03
6 changed files with 11 additions and 16 deletions
+1 -1
View File
@@ -61,7 +61,7 @@ opts = OptionParser.new do |opts|
opts.on('-r', '--ref [REF]', 'Specify the branch to serve. Default: \'master\'.') do |ref|
wiki_options[:ref] = ref
end
opts.on("--bare", "Declare '<git-repo>' to be bare. This is only necessary when using the grit adapter.") do
opts.on("--bare", "Declare '<git-repo>' to be bare.") do
wiki_options[:repo_is_bare] = true
end
opts.on('-a', '--adapter [ADAPTER]', 'Launch Gollum using a specific git adapter. Default: \'rugged\'.') do |adapter|
+4 -6
View File
@@ -20,19 +20,17 @@ end
opts = OptionParser.new do |opts|
opts.banner = <<EOF
Use this tool to migrate a wiki repository created under Gollum versions 4.x or earlier to a 5.x compatibile repo.
It finds and repairs Gollum link tags that no longer work under 5.x for two reasons:
It finds and repairs Gollum link tags that no longer work under 5.x for three reasons:
* 5.x wiki internal links may contain spaces. [[Bilbo Baggins]] and [[Bilbo-Baggins]] therefore link to distinct pages.
* NB: you can use the --hyphened_tag_lookup option in gollum >= 5.x to mimic the behavior from 4.x.
* 5.x wiki internal links are case senitive
* 5.x wiki internal links are no longer 'global'.
* NB: you can use the --global-tag-lookup option in gollum >= 5.x to enable 4.x-style global tags.
* NB: you can use the --lenient-tag-lookup option in gollum >= 5.x to enable 4.x-backwards compatible tags.
See https://github.com/gollum/gollum/wiki/5.0-release-notes#filename-handling for more information.
Usage of this script comes without any warranty.
Note: you can also use this script with the --dry-run option to find broken tags in your wiki.
Usage: gollum-migrate-tags /path/to/repo
NB: without the --write flag, this will be a 'dry run' that doesn't actually make any changes, but outputs the changes that would be made.
@@ -268,5 +266,5 @@ wiki.pages.each do |page|
f.write(new_data)
f.close
end
log(:none, "====")
log(:none, '====')
end