tweek 0.9.7 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8a1c3d0861a2205884049ffbe0ed958cf76595f
-  data.tar.gz: 5f160e90b0d80b153653befacc767eccde42cdfe
+  metadata.gz: 11bb16efc38a6fe8434f28a10c2698d8fd4fa1d2
+  data.tar.gz: 25a57e0842c920ee0b3bc30bdad8dbb4920bfe52
 SHA512:
-  metadata.gz: 2e7bb10c67867e1e8d5612f6b14ca50d2db6b7399927d9f11ee1fb49ae8fccf17f9e88b7d39e6805389d905a0d8e95594a1891ebd71152021fcc3550ffd6905e
-  data.tar.gz: 17cd1c8d386f9d78cda50497b9e2614b98860f77fd730a7eaccc43ae686fc59fe3ac64f05423be29dd29eaedd56b853577c0f8db07f2d63230f989cde347f8eb
+  metadata.gz: 5286ea3679a4b68e783a16494cecbaa209909c54f6e0853fb23be2bcb49028ce868af43c6989e471f9be77c4ee35caffb971beb116f2e3b7d79252fd90cbd11d
+  data.tar.gz: 7a2ebccd37840451bc6f29d7f82bf6e09b61ec442a80dba631992650c7d365a8f1ddc31d5b68e89a801ad4a57cdb2d8493f5aa0df99664d8f8f68516f5f50302

data/README.md

@@ -51,10 +51,10 @@ successful. You should now be able to type `tweek -?` to see the available optio
 
 Tweek can be used in the following modes:
 
- * To check a default configuration
+ * To check the current system against a default configuration
  * To create a sample settings file that you can edit manually
- * To generate a settings file based on the current machine settings
- * To check the current configuration against a file of settings.
+ * To generate a settings file based on the current system configuration
+ * To check the current system configuration against a file of settings.
 
 In the first case Tweek uses a built-in set of defaults. To check using these simply run:
 
@@ -62,25 +62,25 @@ In the first case Tweek uses a built-in set of defaults. To check using these si
 tweek
 ```
 
-Tweek will read the sample settings from the default file `settings/sample.set` and check
-that. The output is self-explanatory.
+Tweek will read the sample settings from the default file `settings/sample.set` (which is
+installed as part of the Gem) and check them. The output is self-explanatory.
 
 All the other uses involve the settings file. Documentation is contained within the
 sample settings and you should read that for a full understanding of what is possible.
 
 ## Settings File Format
 
-The file is a plain-text file that may contain UTF-8 if you are running Ruby 2.0 and
-above, or US-ASCII otherwise.
+The settings file is a plaintext file encoded in UTF-8 (if you are running Ruby 2.0 or
+above) or US-ASCII otherwise.
 
-The overall syntax of the file was designed to be Ruby-like so enabling syntax
-highlighting using Ruby as the language makes it very readable.
+The overall syntax of the file was designed to be Ruby-like so that enabling syntax
+highlighting (using Ruby as the language) makes it very readable.
 
 ### Comments
 
 Comments are of two sorts:
  * Inline: after the first # on any line
- * Block: Following the Ruby convention these are begun with `=begin` and end with `=end`
+ * Block: Following the Ruby convention these begin with `=begin` and end with `=end`
 
 ### Sections
 
@@ -99,7 +99,7 @@ keywords are:
    either a block device or filesystem path corresponding to a mounted `ext4` filesystem.
    Wildcards are allowed.
  * XFS - Settings for XFS filesystems. This must be followed by a parameter containing
-   either a block device or filesystem path corresponding to a mounted `ext4` filesystem.
+   either a block device or filesystem path corresponding to a mounted `xfs` filesystem.
    Wildcards are allowed.
 
 ### Parameters
@@ -116,8 +116,8 @@ For a discussion of which parameters are supported please see the sample setting
 ### Conditionals
 
 Parameter lines can be suffixed by the word `if` and one or more conditions. These are
-used to limit the scope of the parameter check to those systems where the conditions hold
-true. The list of conditions is and'ed together. A condition takes the form:
+used to limit the scope of the parameter check to those systems where the condition(s) hold
+true. The list of conditions is logicall AND'ed together. A condition takes the form:
 
 ```
 [k|d|v] op value
@@ -125,11 +125,15 @@ true. The list of conditions is and'ed together. A condition takes the form:
 
 Where:
  * `k` is the Kernel Version, `d` is the Distro name, and `v` is the Distro version.
- * The operator `op` can be equality '==', regex equality '=~'or a version comparator as
+ * The operator `op` can be: equality '==', regex equality '=~'or a version comparator as
    per the [Rubygems](http://ruby-doc.org/stdlib-2.0.0/libdoc/rubygems/rdoc/Gem/Version.html) specification.
- * The value is one of a plain string in quotes (for equality), a regex between /
+ * The value is one of: a plain string in quotes (for equality), a regex between /
    delimiters, or a plain version string.
 
+NOTE: The determination of the current Distro, Distro Version and Kernel Version is done
+using the `lsb_release` and `uname` commands. Since these may not be installed on all
+systems, you can specify these as command line options. This is also useful in testing.
+
 ## Development
 
 Tweek was developed using the gem `bundler`. Ensure you have both this and `rake` installed using:
@@ -144,11 +148,7 @@ built-in Rake tasks. For a list of these type `rake -T`.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
-To release a new version to the public gem repository, contact the author.
-
-The author will update the version number in `version.rb`, and then run `bundle exec rake
-release`, which will create a git tag for the version, push git commits and tags, and push
-the `.gem` file to [rubygems.org](https://rubygems.org).
+To release a new version to [rubygems.org](https://rubygems.org) please contact the author.
 
 ## Contributing
 

data/bin/tweek

@@ -61,7 +61,7 @@ MSG
     o.parse! rescue (puts "Error: #{$!}"; puts o; exit)
 end
 if distro.nil? or distro_ver.nil?
-  if RUBY_PLATFORM !~ /-linux-gnu$/
+  if RUBY_PLATFORM !~ /\blinux\b/
     STDERR.puts "Tweek only runs on Linux!" 
     exit 2
   end 

data/lib/tweek/version.rb

@@ -1,3 +1,3 @@
 module Tweek
-  VERSION = "0.9.7"
+  VERSION = "0.9.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tweek
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors:
 - Nick Townsend