stepmod-utils 0.3.12 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cede4c978acf6fd33ac7bae2dd5a0020e8f0e9f5ac06e1562f089dd2aa702ee5
-  data.tar.gz: d4cdb2bf5abe663d7089c6d74a939fab72b698ef64a3029695cfd467a423f74d
+  metadata.gz: e40fc2ba271e4bd8e0859cb307831ead927b7bc12154b5845f528694ad18c8f8
+  data.tar.gz: e1b6f691a70d1e6531a7f841b5a998d49d6c376a84a9da340246b2920bd8459d
 SHA512:
-  metadata.gz: 9f9db582dd4c85836ed96c8916024d9cf75c8019a512305634df73af0be3dbe9faf53ea2e8b516afe7417f0c68a50f5b27303d5034cf627fcdbacf4e05a3f1c5
-  data.tar.gz: 52cd06f6cd0a044d4e904a6daa85d2802a9731b1b2aa13643087b71c60f3c106f67623dca248a00c970f48875faf415776b3f48de74bf51539b6a3c94b9f57f2
+  metadata.gz: e5e62c15d95982deb33e03af65b9720cdb34746adfa36bf5945a2823fb0be9800beff3e8cf4b3e4acd34ebf940bacb0ff2b4a83b31af27e8d01cba2599fcc537
+  data.tar.gz: c9efdfa5eed962291c9454227e8d2c7c22b4ba665c88745d059f77cdfb5ae2bdb414d32d7c1ee957aec10db634c1f0fbc388851360ae4edb9bf9d721f740dca3

data/.github/workflows/rake.yml

@@ -10,23 +10,6 @@ on:
 
 jobs:
   rake:
-    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ false ]
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - run: bundle exec rake
+    uses: metanorma/metanorma-build-scripts/.github/workflows/generic-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -15,32 +15,10 @@ on:
 
 jobs:
   release:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
+    uses: metanorma/metanorma-build-scripts/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+      event_name: ${{ github.event_name }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
 
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '2.6'
-          bundler-cache: true
-
-      - run: gem install gem-release
-
-      - run: |
-          git config user.name github-actions
-          git config user.email github-actions@github.com
-
-      - if: github.event_name == 'workflow_dispatch' && github.event.inputs.next_version != 'skip'
-        run: gem bump --version ${{ github.event.inputs.next_version }} --tag --push
-
-      - name: publish to rubygems.org
-        env:
-          RUBYGEMS_API_KEY: ${{secrets.METANORMA_CI_RUBYGEMS_API_KEY}}
-        run: |
-          gem install gem-release
-          envsubst << 'EOF' > ~/.gem/credentials
-          ---
-          :rubygems_api_key: ${RUBYGEMS_API_KEY}
-          EOF
-          chmod 0600 ~/.gem/credentials
-          gem release

data/README.adoc

@@ -10,12 +10,8 @@ image:https://img.shields.io/github/commits-since/metanorma/stepmod-utils/latest
 
 == Purpose
 
-The `stepmod-utils` Ruby gem provides a number of tools to work with the STEPmod repository.
-
-
-== CVS to Git migration procedures
-
-include::migrating_from_cvs.adoc[]
+The `stepmod-utils` Ruby gem provides a number of tools to work with the STEPmod
+repository.
 
 
 == Installation
@@ -31,11 +27,8 @@ Or include it in your gemspec.
 
 [source,sh]
 ----
-# Extracts from current directory
-$ stepmod-extract-terms
-
-# Extracts from specified stepmod/ or stepmod/data/ directory
-$ stepmod-extract-terms {stepmod-data-directory}
+# Extracts from specified stepmod/data/ directory
+$ stepmod-extract-terms -p {stepmod-data-directory} -i {path-to-repository_index.xml}
 ----
 
 Then these files will be created:
@@ -118,48 +111,15 @@ expg_image:contract_schemaexpg1.xml[]
 expg_image:contract_schemaexpg2.xml[]
 ----
 
+== Git repository
 
-== CVS revision detection
-
-If the STEPmod repository is a CVS repository, it will display the
-working and repository revisions as comments.
-
-WARNING: CVS revision detection can be *slow*! Be patient.
-
-Sample output:
-
-[source,sh]
-----
-[stepmod-utils] INFO: STEPmod directory set to ../x/stepmod/.
-[stepmod-utils] INFO: STEPmod directory is a CVS repository and will detect revisions.
-[stepmod-utils] INFO: [CVS] Detecting file revisions can be slow, please be patient!
-[stepmod-utils] INFO: Detecting paths...
-[stepmod-utils] INFO: Processing XML file data/business_object_models/managed_model_based_3d_engineering/business_object_model.xml
-[stepmod-utils] INFO: Detecting CVS revision...
-[stepmod-utils] INFO: CVS working rev (1.148), repo rev (1.148)
-[stepmod-utils] INFO: Completed processing XML file data/business_object_models/managed_model_based_3d_engineering/business_object_model.xml
-[stepmod-utils] INFO: Processing XML file data/business_object_models/managed_model_based_3d_engineering_domain/business_object_model.xml
-[stepmod-utils] INFO: Detecting CVS revision...
-[stepmod-utils] INFO: CVS working rev (1.31), repo rev (1.31)
-[stepmod-utils] INFO: Completed processing XML file data/business_object_models/managed_model_based_3d_engineering_domain/business_object_model.xml
-...
- stepmod/data/business_object_models/managed_model_based_3d_engineering_domain/business_object_model.xml
-[stepmod-utils] INFO: written to: 031-generated-terms.adoc
-[stepmod-utils] INFO: written to: 991-generated-bibliography.adoc
-----
-
-
-== Non-CVS repository
-
-If the STEPmod repository is not a CVS repository, or if the `cvs` executable
-cannot be found, term extract will still work.
+If the STEPmod repository is a Git repository, term extract will work.
 
 Sample output:
 
 [source,sh]
 ----
 [stepmod-utils] INFO: STEPmod directory set to ../iso-10303-stepmod.
-[stepmod-utils] INFO: STEPmod directory is not a CVS repository, skipping revision detection.
 [stepmod-utils] INFO: Detecting paths...
 [stepmod-utils] INFO: Processing XML file data/application_protocols/boundary_representation_for_iso_14306_open_jt/application_protocol.xml
 [stepmod-utils] INFO: skipped ISO/CD 10303-243 as it is not IS, DIS or TS

data/exe/stepmod-extract-terms

@@ -20,15 +20,52 @@ end
 
 require "bundler/setup"
 require "stepmod/utils/terms_extractor"
+require 'optparse'
 
-stepmod_dir = ARGV.first || Dir.pwd
+def log(message)
+  puts "[stepmod-utils] #{message}"
+end
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options]"
+
+  opts.on("-p", "--path STEPMOD_DATA_PATH", String, "Path to STEPmod data directory") do |path|
+    options[:stepmod_dir] = path
+  end
+
+  opts.on("-i", "--index INDEX_PATH", String, "Path to repository_index.xml") do |path|
+    unless path.nil?
+      options[:index_path] = Pathname.new(path).to_s
+    end
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+stepmod_dir = options[:stepmod_dir]
+if stepmod_dir.nil?
+  raise StandardError.new("STEPmod data path not set, set with the `-p` option.")
+else
+  log "STEPmod data path: `#{stepmod_dir}`"
+end
+
+index_path = options[:index_path] || File.join(stepmod_dir, "repository_index.xml")
+unless File.exists?(index_path)
+  raise StandardError.new("Index file not present at #{index_path}, set with the `-i` option.")
+else
+  log "Repository index path: `#{index_path}`"
+end
 
 general_concepts,
 resource_concepts,
 parsed_bibliography,
 part_concepts,
 part_resources,
-part_modules = Stepmod::Utils::TermsExtractor.call(stepmod_dir)
+part_modules = Stepmod::Utils::TermsExtractor.call(stepmod_dir, index_path)
 
 def part_to_title(bibdata)
   case bibdata.part.to_i
@@ -69,10 +106,6 @@ def replace_images(content)
   content
 end
 
-def log(message)
-  puts "[stepmod-utils] #{message}"
-end
-
 part_concepts.each do |(bibdata, current_part_concepts)|
   current_part_concepts = current_part_concepts.to_a.map do |n|
     n.localizations["en"]

data/lib/stepmod/utils/cleaner.rb

@@ -4,7 +4,9 @@ module Stepmod
   module Utils
     class Cleaner < ReverseAdoc::Cleaner
       def tidy(string)
-        super.gsub(/^ +/, "")
+        super
+          .gsub(/^ +/, "")
+          .gsub(/\*\s([,.])/, '*\1') # remove space between * and comma or dot.
       end
     end
   end

data/lib/stepmod/utils/concept.rb

@@ -124,7 +124,7 @@ module Stepmod
 
       def to_mn_adoc
         <<~TEXT
-          // STEPmod path:#{!file_path.empty? ? " #{file_path}" : ''}
+          // STEPmod path:#{file_path.empty? ? '' : " #{file_path}"}
           #{converted_definition}
 
           [.source]

data/lib/stepmod/utils/converters/ext_description.rb

@@ -3,7 +3,7 @@ module Stepmod
     module Converters
       class ExtDescription < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          state = state.merge(schema_name: node["linkend"])
+          state = state.merge(schema_name: node["linkend"], non_flanking_whitesapce: true)
           child_text = treat_children(node, state).strip
 
           <<~TEMPLATE

data/lib/stepmod/utils/converters/stepmod_ext_description.rb

@@ -43,10 +43,10 @@ module Stepmod
 
           domain =  case linkend.first
                     when /_mim$/, /_arm$/
-                      "STEP module"
+                      "ISO 10303 application module"
                     # when /_schema$/
                     else
-                      "STEP resource"
+                      "ISO 10303 resource"
                     end
 
           <<~TEMPLATE

data/lib/stepmod/utils/converters/strong.rb

@@ -8,12 +8,13 @@ module Stepmod
 
         def convert(node, state = {})
           content = treat_children(node, state.merge(already_strong: true))
+          strong_tag = state[:non_flanking_whitesapce] ? '**' : '*'
           if content.strip.empty? || state[:already_strong]
             content
           else
             handle_express_escape_seq(
               node,
-              "#{content[/^\s*/]}*#{content.strip}*#{content[/\s*$/]}"
+              "#{content[/^\s*/]}#{strong_tag}#{content.strip}#{strong_tag}#{content[/\s*$/]}"
             )
           end
         end

data/lib/stepmod/utils/converters/term.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "stepmod/utils/converters/synonym"
+require "stepmod/utils/term"
+require "glossarist"
 
 module Stepmod
   module Utils
@@ -22,22 +24,20 @@ module Stepmod
           unless first_child &&
               node.text.split(";").length == 2 &&
               defined?(Stepmod::Utils::Converters::Synonym)
-            return "=== #{treat_acronym(treat_children(node, state).strip)}"
+
+            return Stepmod::Utils::Term.from_h(
+              "definition" => treat_children(node, state).strip,
+            ).to_mn_adoc
           end
 
           term_def, alt = node.text.split(";")
           alt_xml = Nokogiri::XML::Text.new(alt, Nokogiri::XML::Document.new)
           converted_alt = Stepmod::Utils::Converters::Synonym.new.convert(alt_xml)
-          "=== #{treat_acronym(term_def)}\n\n#{converted_alt}"
-        end
-
-        private
-
-        def treat_acronym(term_def)
-          return term_def.strip if term_def !~ /.+\(.+?\)$/
 
-          _, term_text, term_acronym = term_def.match(/(.+?)(\(.+\))$/).to_a
-          "#{term_text.strip}\nalt:[#{term_acronym.gsub(/\(|\)/, '')}]"
+          Stepmod::Utils::Term.from_h(
+            "definition" => term_def,
+            "synonyms" => [converted_alt],
+          ).to_mn_adoc
         end
       end
 

data/lib/stepmod/utils/converters/uof.rb

@@ -14,7 +14,7 @@ module Stepmod
           # <<~TEXT
           # === #{node['name'].strip}
 
-          # <STEP module> #{treat_children(node, state).strip}
+          # <ISO 10303 application module> #{treat_children(node, state).strip}
           # TEXT
         end
       end

data/lib/stepmod/utils/stepmod_definition_converter.rb

@@ -17,6 +17,7 @@ require "stepmod/utils/converters/term"
 require "stepmod/utils/converters/synonym"
 require "stepmod/utils/converters/uof"
 require "stepmod/utils/converters/figure"
+require "stepmod/utils/cleaner"
 
 require "reverse_adoc/converters/a"
 require "reverse_adoc/converters/blockquote"
@@ -56,7 +57,7 @@ module Stepmod
                                                                      options)
           return "" unless result
 
-          ReverseAdoc.cleaner.tidy(result.dup)
+          Stepmod::Utils::Cleaner.new.tidy(result.dup)
         end
       end
     end

data/lib/stepmod/utils/term.rb

@@ -0,0 +1,38 @@
+require "glossarist"
+
+module Stepmod
+  module Utils
+    class Term < Glossarist::LocalizedConcept
+      # Term acronym
+      attr_accessor :acronym
+
+      def to_mn_adoc
+        mn_adoc = ["=== #{definition}"]
+        mn_adoc << "\nalt:[#{acronym}]" if acronym
+        mn_adoc << "\n\n#{designations.join(", ")}" if designations&.any?
+
+        mn_adoc.join
+      end
+
+      class << self
+        def from_h(hash)
+          _, definition, acronym = treat_acronym(hash["definition"])
+
+          hash["definition"] = definition
+          hash["acronym"] = acronym.gsub(/\(|\)/, "") if acronym
+          hash["designations"] = hash["synonyms"]
+
+          super(hash.reject { |k, _| k == "synonyms" })
+        end
+
+        private
+
+        def treat_acronym(term_def)
+          return [nil, term_def.strip, nil] unless term_def.match?(/.+\(.+?\)$/)
+
+          term_def.match(/(.+?)(\(.+\))$/).to_a
+        end
+      end
+    end
+  end
+end

data/lib/stepmod/utils/terms_extractor.rb

@@ -15,24 +15,25 @@ module Stepmod
 
       attr_reader :stepmod_path,
                   :stepmod_dir,
+                  :index_path,
                   :general_concepts,
                   :resource_concepts,
                   :parsed_bibliography,
                   :encountered_terms,
-                  :cvs_mode,
                   :part_concepts,
                   :part_resources,
                   :part_modules,
                   :stdout
 
-      def self.call(stepmod_dir, stdout = $stdout)
-        new(stepmod_dir, stdout).call
+      def self.call(stepmod_dir, index_path, stdout = $stdout)
+        new(stepmod_dir, index_path, stdout).call
       end
 
-      def initialize(stepmod_dir, stdout)
+      def initialize(stepmod_dir, index_path, stdout)
         @stdout = stdout
         @stepmod_dir = stepmod_dir
         @stepmod_path = Pathname.new(stepmod_dir).realpath
+        @index_path = Pathname.new(index_path).to_s
         @general_concepts = Glossarist::Collection.new
         @resource_concepts = Glossarist::Collection.new
         @parsed_bibliography = []
@@ -58,28 +59,10 @@ module Stepmod
       end
 
       def call
-        # If we are using the stepmod CVS repository, provide the revision number per file
-        @cvs_mode = if Dir.exists?(stepmod_path.join("CVS"))
-                      require "ptools"
-                      # ptools provides File.which
-                      File.which("cvs")
-                    end
-
         log "INFO: STEPmod directory set to #{stepmod_dir}."
-
-        if cvs_mode
-          log "INFO: STEPmod directory is a \
-            CVS repository and will detect revisions."
-          log "INFO: [CVS] Detecting file revisions can be slow, \
-            please be patient!"
-        else
-          log "INFO: STEPmod directory is not a CVS repository, \
-            skipping revision detection."
-        end
-
         log "INFO: Detecting paths..."
 
-        repo_index = Nokogiri::XML(File.read(stepmod_path.join("repository_index.xml"))).root
+        repo_index = Nokogiri::XML(File.read(@index_path)).root
 
         files = []
 
@@ -159,24 +142,15 @@ module Stepmod
             next
           end
 
-          revision_string = "\n// CVS: revision not detected"
-          if cvs_mode
-            # Run `cvs status` to find out version
-
-            log "INFO: Detecting CVS revision..."
-            Dir.chdir(stepmod_path) do
-              status = `cvs status #{fpath}`
-
-              unless status.empty?
-                working_rev = status.split(/\n/).grep(/Working revision:/)
-                  .first.match(/revision:\s+(.+)$/)[1]
-                repo_rev = status.split(/\n/).grep(/Repository revision:/)
-                  .first.match(/revision:\t(.+)\t/)[1]
-                log "INFO: CVS working rev (#{working_rev}), \
-                  repo rev (#{repo_rev})"
-                revision_string = "\n// CVS working rev: (#{working_rev}), repo rev (#{repo_rev})\n" +
-                  "// CVS: revision #{working_rev == repo_rev ? 'up to date' : 'differs'}"
-              end
+          revision_string = ""
+
+          # Run `cvs status` to find out version
+          log "INFO: Detecting Git SHA..."
+          Dir.chdir(stepmod_path) do
+            git_sha = `git rev-parse HEAD`
+
+            unless git_sha.empty?
+              revision_string = "\n// Git: SHA #{git_sha}"
             end
           end
 

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.3.12".freeze
+    VERSION = "0.3.16".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.12
+  version: 0.3.16
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-31 00:00:00.000000000 Z
+date: 2022-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -213,16 +213,16 @@ files:
 - lib/stepmod/utils/smrl_resource_converter.rb
 - lib/stepmod/utils/stepmod_definition_converter.rb
 - lib/stepmod/utils/stepmod_file_annotator.rb
+- lib/stepmod/utils/term.rb
 - lib/stepmod/utils/terms_extractor.rb
 - lib/stepmod/utils/version.rb
-- migrating_from_cvs.adoc
 - resource_example.xml
 - stepmod-utils.gemspec
 homepage: https://github.com/metanorma/stepmod-utils
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -237,8 +237,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Stepmod-utils is a toolkit that works on STEPmod data.
 test_files: []

data/migrating_from_cvs.adoc

@@ -1,190 +0,0 @@
-= STEPmod CVS to Git import
-
-== Purpose
-
-The `cvs/` submodule is a CSV import of STEPmod files from the CVS server hosted at Boost Conseil.
-
-The goal is to import the CSV-managed files in a way useable via Git, with full history information.
-
-This guide is used as reference for the usage of `cvs-fast-import`:
-https://oitofelix.github.io/article-savannah-cvs-to-git-migration/
-
-
-== Strategy to import
-
-Cloning a remote CVS repository while importing is super slow,
-especially for a large repository like STEPmod.
-
-We have tested and settled on these steps:
-
-. Maintain a local `rsync` copy of the CVS repository.
-. Resolve all names from the CVS repository (CVS only stores UNIX usernames, in Git are names and emails) using `cvs-fast-import`.
-. Run `cvs-fast-import` to import the CVS repository into the `iso-10303-stepmod-cvs` Git repo.
-
-
-== Creating the `rsync` clone of the CVS repository
-
-[source,sh]
-----
-rsync -avrPz -e ssh ronald@cvs.boost-lab.net:/stepmod/ stepmod-rsync/
-----
-
-
-== Install cvs-fast-export
-
-`cvs-fast-export` only works on Linux.
-Run it on Ubuntu with the `rsync`'ed CVS directory.
-
-Install:
-[source,sh]
-----
-$ apt-get -y install cvs-fast-export
-----
-
-== Getting all users for email mapping
-
-Find all authors in the CVS repository using `cvs-fast-export -a`.
-It is much faster than using the equivalent CVS command to list all authors.
-
-[source,sh]
-----
-$ find stepmod-rsync -type f | cvs-fast-export -a
-----
-
-
-== Create fast-import file for Git
-
-After all authors are mapped, run `cvs-fast-export` to create
-the import file.
-
-[source,sh]
-----
-$ find stepmod-rsync -type f | cvs-fast-export -A author-map.txt > fast-import-file
-----
-
-== Perform the Git fast-import
-
-Once the fast-import file is created, we can perform the Git import.
-
-[source,sh]
-----
-$ cd iso-10303-stepmod-cvs
-$ git fast-import < ../fast-import-file
-----
-
-
-== Upload the new Git repo
-
-[source,sh]
-----
-git push --all && git push --tags
-----
-
-
-== DEPRECATED steps using `git cvsimport` (do not use, it won't work)
-
-=== General
-
-https://stackoverflow.com/questions/11362676/how-to-import-and-keep-updated-a-cvs-repository-in-git[This StackOverflow post]
-describes steps for using `git cvsimport`.
-
-Originally the `git cvsimport` tool was chosen since it is part of
-`git`. However, it utilizes a deprecated/unmaintained tool called
-`cvsps`. The latest `cvsps` is version 3, but only version 2 is
-compatible with `git cvsimport`.
-
-In addition, the `cvsps` tool is maintained by the maintainer
-of `cvs-fast-import`, and is no longer updated.
-Eventually `cvs-fast-import` is used instead.
-
-WARNING: This command completely fails
-on this repository because it is too large and complex.
-
-
-=== Setup
-
-On macOS, run the following commands to setup for running the import. The `git` executable must be installed.
-
-Install `cvsps` version 2.
-
-NOTE: The steps from the StackOverflow of installing `cvsps` no longer work.
-
-[source,sh]
-----
-$ brew tap Frizlab/Perso
-# ==> Tapping frizlab/perso
-# Cloning into '/usr/local/Homebrew/Library/Taps/frizlab/homebrew-perso'...
-# remote: Enumerating objects: 123, done.
-# remote: Total 123 (delta 0), reused 0 (delta 0), pack-reused 123
-# Receiving objects: 100% (123/123), 19.08 KiB | 91.00 KiB/s, done.
-# Resolving deltas: 100% (43/43), done.
-# Tapped 1 cask and 10 formulae (38 files, 60.5KB).
-
-$ brew install cvsps@2
-# ==> Installing cvsps@2 from frizlab/perso
-# Warning: A newer Command Line Tools release is available.
-# Update them from Software Update in System Preferences or
-# https://developer.apple.com/download/more/.
-# ==> Downloading https://deb.debian.org/debian/pool/main/c/cvsps/cvsps_2.1.orig.tar.gz
-######################################################################## 100.0%
-# ==> make all
-# ==> make install prefix=/usr/local/Cellar/cvsps@2/2.1
-# 🍺  /usr/local/Cellar/cvsps@2/2.1: 7 files, 124.6KB, built in 6 seconds
-----
-
-Verify it is installed:
-[source,sh]
-----
-$ cvsps -v
-# Can't open CVS/Root
-# cannot determine CVSROOT
-----
-
-////
-== Checkout the CVS repository
-
-First set the `CVSROOT` and `CVS_RSH` variables.
-
-[source,sh]
-----
-export CVSROOT=:ext:ronald@cvs.boost-lab.net:/stepmod
-export CVS_RSH=ssh
-cvs checkout stepmod
-# => stepmod/ is created in $PWD
-----
-////
-
-
-=== Run the import
-
-Run the import from CVS to Git.
-
-Go to the directory that will carry the target Git repository.
-
-Run `git cvsimport`.
-
-[source,sh]
-----
-# Importing from remote
-$ export CVSROOT=:ext:ronald@cvs.boost-lab.net:/stepmod
-$ export CVS_RSH=ssh
-$ git cvsimport -C iso-10303-stepmod-cvs -r cvs -k -v -d $CVSROOT stepmod
-
-# Importing from local rsync'ed copy
-$ export CVSROOT=$(pwd)/stepmod-rsync
-$ git cvsimport -C iso-10303-stepmod-cvs -r cvs -k -v -d $CVSROOT stepmod
-----
-
-WARNING: TLDR. Technically this should work, but I ran into a `cvsps cannot allocate memory` error with 64GB of RAM, and not even completing the clone after 24 hours. So I gave up and switched to local. And local still takes a long time with tons of error messages. `cvs-fast-import` only takes 5-10 minutes to import.
-
-
-=== Updating the CVS import
-
-Run `git cvsimport` to synchronize the Git repo using updated data from CVS.
-
-[source,sh]
-----
-$ git cvsimport
-----
-
-