Update utils

utils/clean_all.rb

@@ -1,29 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-#
-# MIT License
+# SPDX-License-Identifier: MIT
 #
 # Copyright (c) 2018-2019 Andre Richter <andre.o.richter@gmail.com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-#
 
 require 'fileutils'
 require_relative 'helpers/tutorial_folders.rb'

utils/clippy_all.rb

@@ -1,37 +1,20 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-#
-# MIT License
+# SPDX-License-Identifier: MIT
 #
 # Copyright (c) 2018-2019 Andre Richter <andre.o.richter@gmail.com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-#
+
+require_relative 'helpers/tutorial_folders.rb'
 
 def clippy_all
-  crates = Dir['*/Cargo.toml'].sort!
+  crates = tutorial_folders
 
   crates.each do |x|
     x = File.dirname(x)
 
     Dir.chdir(x) do
+      puts "Clippy: #{x}"
       system('make clippy')
     end
   end

utils/diff_all.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: MIT
+#
+# Copyright (c) 2018-2019 Andre Richter <andre.o.richter@gmail.com>
+
+require 'fileutils'
+require_relative 'helpers/tutorial_folders.rb'
+
+def diff_all
+  crates = tutorial_folders
+
+  for i in 0..(crates.length - 2)
+    old = File.dirname(crates[i])
+    new = File.dirname(crates[i + 1])
+    puts "Diffing #{old} -> #{new}"
+    system("bash utils/helpers/diff_tut_folders.bash #{old} #{new}")
+  end
+end
+
+clean_all if $PROGRAM_NAME == __FILE__

utils/fmt_all.rb

@@ -1,32 +1,14 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-#
-# MIT License
+# SPDX-License-Identifier: MIT
 #
 # Copyright (c) 2018-2019 Andre Richter <andre.o.richter@gmail.com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-#
+
+require_relative 'helpers/tutorial_folders.rb'
 
 def fmt_all
-  crates = Dir['**/Cargo.toml'].sort!
+  crates = tutorial_folders
 
   crates.each do |x|
     x = File.dirname(x)

utils/helpers/copyrighted.rb

@@ -1,28 +1,8 @@
 # frozen_string_literal: true
 
+# SPDX-License-Identifier: MIT
 #
-# MIT License
-#
-# Copyright (c) 2019 Andre Richter <andre.o.richter@gmail.com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-#
+# Copyright (c) 2018-2019 Andre Richter <andre.o.richter@gmail.com>
 
 def checkin_years(file)
   checkin_years = `git --no-pager log \

utils/helpers/diff_tut_folders.bash

@@ -1,5 +1,9 @@
 #!/usr/bin/env bash
 
+# SPDX-License-Identifier: MIT
+#
+# Copyright (c) 2018-2019 Andre Richter <andre.o.richter@gmail.com>
+
 DIFF=$(
     diff -uNr \
 	 -x README.md \
@@ -8,10 +12,18 @@ DIFF=$(
 	 -x Cargo.lock \
 	 -x target \
 	 $1 $2 \
-        | sed -r "s/[12][90][127][90]-.*//g"
+	| sed -r "s/[12][90][127][90]-.*//g" \
+	| sed -r "s/[[:space:]]*$//g"
      )
 
-printf "\n\n## Diff to previous\n" >> "$2/README.md"
+HEADER="## Diff to previous"
+ORIGINAL=$(
+    cat $2/README.md \
+	| sed -rn "/$HEADER/q;p"
+	)
+
+printf "$ORIGINAL" > "$2/README.md"
+printf "\n\n$HEADER\n" >> "$2/README.md"
 printf "\`\`\`diff\n" >> "$2/README.md"
 printf "${DIFF//'diff -uNr -x README.md -x kernel -x kernel8.img -x Cargo.lock -x target'/'\ndiff -uNr'}" >> "$2/README.md"
 printf "\n\`\`\`\n" >> "$2/README.md"

utils/helpers/tutorial_folders.rb

@@ -1,41 +1,18 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-#
-# MIT License
+# SPDX-License-Identifier: MIT
 #
 # Copyright (c) 2018-2019 Andre Richter <andre.o.richter@gmail.com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-#
 
 require 'fileutils'
 
-EXCLUDES = [
-  'boot2rust',
-  'bsp'
-].freeze
-
 def tutorial_folders
   crates = Dir['**/Cargo.toml']
 
-  EXCLUDES.each { |x| crates.delete_if { |y| y.include?(x) } }
+  crates.delete_if do |x|
+    !/[0-9][0-9]/.match?(x[0..1])
+  end
 
   crates.sort!
 end

utils/make_all.rb

@@ -1,29 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-#
-# MIT License
+# SPDX-License-Identifier: MIT
 #
 # Copyright (c) 2018-2019 Andre Richter <andre.o.richter@gmail.com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-#
 
 require_relative 'helpers/tutorial_folders.rb'
 

utils/raspboot.bash

@@ -1,5 +1,9 @@
 #!/usr/bin/env bash
 
+# SPDX-License-Identifier: MIT
+#
+# Copyright (c) 2018-2019 Andre Richter <andre.o.richter@gmail.com>
+
 CONTAINER_UTILS="rustembedded/osdev-utils"
 
 DOCKER_CMD="docker run -it --rm"

utils/ready_for_publish.rb

@@ -1,35 +1,16 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-#
-# MIT License
+# SPDX-License-Identifier: MIT
 #
 # Copyright (c) 2018-2019 Andre Richter <andre.o.richter@gmail.com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-#
 
 require_relative 'clean_all'
 require_relative 'clippy_all'
 require_relative 'fmt_all'
 require_relative 'make_all'
 require_relative 'sanity_checks'
+require_relative 'diff_all'
 
 clean_all
 fmt_all
@@ -38,3 +19,4 @@ clippy_all
 
 clean_all
 make_all
+diff_all

utils/sanity_checks.rb

@@ -1,34 +1,15 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-#
-# MIT License
+# SPDX-License-Identifier: MIT
 #
 # Copyright (c) 2018-2019 Andre Richter <andre.o.richter@gmail.com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-#
 
 require_relative 'helpers/copyrighted'
+require_relative 'helpers/tutorial_folders.rb'
 
 def patched?
-  crates = Dir['**/Cargo.toml'].sort!
+  crates = tutorial_folders
 
   crates.each do |f|
     unless File.readlines(f).grep(/patch.crates-io/).empty?
@@ -48,6 +29,7 @@ def check_old_copyrights
   end
 
   sources.sort.reverse_each do |f|
+    puts "Checking for copyright: #{f}"
     error = true unless copyrighted?(f, false)
   end