Merge pull request #3035 from znz/markdown/add-manual-tree

manual/: Markdown ソースツリーの追加とビルドの切り替え

Author: znz

Gemfile.lock

@@ -1,9 +1,10 @@
 GIT
   remote: https://github.com/rurema/bitclust.git
-  revision: 2a2028ac761cee63a27eb24f7b6673da4b9fbd3e
+  revision: c7500e5e2f5d2ed765af5e81e524d7e50734829d
   specs:
     bitclust-core (1.4.0)
       drb
+      json
       nkf
       progressbar (>= 1.9.0, < 2.0)
       rack
@@ -16,15 +17,16 @@ GIT
 GEM
   remote: https://rubygems.org/
   specs:
-    drb (2.2.1)
-    nkf (0.2.0)
+    drb (2.2.3)
+    json (2.20.0)
+    nkf (0.3.0)
     progressbar (1.13.0)
-    rack (3.1.21)
+    rack (3.2.6)
     rackup (2.1.0)
       rack (>= 3)
       webrick (~> 1.8)
     rake (13.2.1)
-    webrick (1.8.2)
+    webrick (1.9.2)
 
 PLATFORMS
   ruby

Rakefile

@@ -14,20 +14,32 @@ def system(*commands)
   super(*commands)
 end
 
+# ソースは manual/ の Markdown ツリー（manual/doc は manual/api から自動で取り込まれる）。
+# 旧 refm/ は移行ウィンドウ中の凍結ソース。旧経路でビルドしたい場合は
+# BITCLUST_SOURCE=refm を指定する。
 def generate_database(version)
   puts "generate database of #{version}"
   db = "/tmp/db-#{version}"
   succeeded = system("bundle", "exec",
                      "bitclust", "--database=#{db}",
                      "init", "version=#{version}", "encoding=UTF-8")
   raise "Failed to initialize BitClust database" unless succeeded
-  succeeded = system("bundle", "exec", "bitclust", "--database=#{db}",
-                     "update", "--stdlibtree=refm/api/src")
-  raise "Failed to update BitClust database" unless succeeded
-  capi_files = Dir.glob("refm/capi/src/*")
-  succeeded = system("bundle", "exec", "bitclust", "--database=#{db}", "--capi",
-                     "update", *capi_files)
-  raise "Failed to update BitClust C API database" unless succeeded
+  if ENV["BITCLUST_SOURCE"] == "refm"
+    succeeded = system("bundle", "exec", "bitclust", "--database=#{db}",
+                       "update", "--stdlibtree=refm/api/src")
+    raise "Failed to update BitClust database" unless succeeded
+    capi_files = Dir.glob("refm/capi/src/*")
+    succeeded = system("bundle", "exec", "bitclust", "--database=#{db}", "--capi",
+                       "update", *capi_files)
+    raise "Failed to update BitClust C API database" unless succeeded
+  else
+    succeeded = system("bundle", "exec", "bitclust", "--database=#{db}",
+                       "update", "--markdowntree=manual/api")
+    raise "Failed to update BitClust database" unless succeeded
+    succeeded = system("bundle", "exec", "bitclust", "--database=#{db}", "--capi",
+                       "update", "--markdowntree=manual/capi")
+    raise "Failed to update BitClust C API database" unless succeeded
+  end
 end
 
 def generate_statichtml(version)
@@ -57,7 +69,7 @@ def generate_statichtml(version)
   raise "Failed to generate static html" unless succeeded
 end
 
-task :default => [:check_indent_in_samplecode, :generate, :check_format]
+task :default => [:check_filename_case_conflicts, :check_indent_in_samplecode, :generate, :check_format]
 
 namespace :generate do
   ALL_VERSIONS.each do |version|
@@ -151,10 +163,27 @@ task check_format: [:statichtml] do
   end
 end
 
+desc 'Check file names that differ only in case'
+task :check_filename_case_conflicts do
+  # 大文字小文字のみが異なるファイル名は macOS/Windows の case-insensitive な
+  # ファイルシステムでチェックアウト不能になる（manual/api/rdoc/rdoc.lib.md の
+  # ような .lib 回避と front matter の name: については bitclust の
+  # doc/markdown-samples/MARKUP_SPEC.md §1.3 を参照）
+  errors = Dir.glob('{manual,refm}/**/*')
+              .group_by(&:downcase).values
+              .select { |paths| paths.size > 1 }
+              .map { |paths| "大文字小文字のみが異なるファイル名があります: #{paths.sort.join(' / ')}" }
+
+  unless errors.empty?
+    puts errors
+    fail
+  end
+end
+
 desc 'Check unnecessary indentation in samplecode'
 task :check_indent_in_samplecode do
   errors = []
-  `grep -rlF '\#@samplecode' refm`.lines(chomp: true).each do |path|
+  `grep -rlF '\#@samplecode' manual refm`.lines(chomp: true).each do |path|
     lines = File.read(path).lines(chomp: true)
     lines.each.with_index(1) do |line, lineno|
       next unless line.start_with?('#@samplecode')