Correctly sync generated files with source

* Correct use of variable with two file names
* Correctly use variable with two file names
  Introduced in 23721cd as a fix to a shellcheck warning.
* Include fullstops in list
* Clarify export command
* Update examples
* Fix typo in e.g.

Issue: #58

Author: dspinellis

README.md

@@ -136,7 +136,7 @@ You use _git issue_ with the following sub-commands.
 
   The command can read, add/remove or edit any of the issue's attributes.
   Some potentially useful scripts to be used with this command are in the scripts/ directory.
-  Remember to inspect the results (e.g `gi git diff`) and commit them with `gi git commit -a`.
+  Remember to inspect the results (e.g. `gi git diff`) and commit them with `gi git commit -a`.
 
 ### Synchronize with remote repositories
 * `git issue push`: Update remote Git repository with local changes.
@@ -152,11 +152,11 @@ You use _git issue_ with the following sub-commands.
   In case the repository is part of a GitLab group, specify repository as groupname/reponame.
 * `git issue create`: Create the issue in the provided GitHub repository.
   With the `-e` option any escape sequences for the attributes present in the description, will be replaced as above.
-  This can be used to e.g export an unsupported attribute to GitHub as text.
-* `git issue export`: Export issues for the specified project.
+  This can be used to e.g. export an unsupported attribute to GitHub as text.
+* `git issue export`: Export modified issues for the specified project.
   Only the issues that have been imported and modified (or created by `git issue create`) by `git-issue` will be exported.
   With the `-e` option any escape sequences for the attributes present in the description, will be replaced as above.
-  This can be used to e.g export an unsupported attribute to GitHub as text.
+  This can be used to e.g. export an unsupported attribute to GitHub as text.
 * `git issue exportall`: Export all open issues in the database (`-a` to include closed ones) to GitHub/GitLab. Useful for cloning whole repositories.
 
 ### Help and debug
@@ -497,14 +497,14 @@ Edited comment d72c68d
 
 ```
 $ git issue export github dspinellis git-issue-test-issues # Needs a token with the relevant permissions
-Issue b83d92872dc16440402516a5f4ce1b8cc6436344 hasn't been modified, skipping...
-Comment a93764f32179e93493ceb0a7060efce1e980aff1 hasn't been modified, skipping...
+Issue b83d92872dc16440402516a5f4ce1b8cc6436344 not modified, skipping...
+Comment a93764f32179e93493ceb0a7060efce1e980aff1 not modified, skipping...
 Exporting issue 9179d381135273220301f175c03b101b3e9c703d as #15
-Issue 3651dd38e4e1d9dbce66649710324235c773fe78 hasn't been modified, skipping...
+Issue 3651dd38e4e1d9dbce66649710324235c773fe78 not modified, skipping...
 Updating comment d72c68d0177b500a91ea37548e6594f84457fd5b...
-Comment 6966d4d718c80cf8635e9276d6f391de70c22f93 hasn't been modified, skipping...
-Comment 85293a6904d0fbd6238fbb2e1c36fc65af9ffc60 hasn't been modified, skipping...
-Comment aea83723c0414ff135afcfb5165d64f8a7ad687c hasn't been modified, skipping...
+Comment 6966d4d718c80cf8635e9276d6f391de70c22f93 not modified, skipping...
+Comment 85293a6904d0fbd6238fbb2e1c36fc65af9ffc60 not modified, skipping...
+Comment aea83723c0414ff135afcfb5165d64f8a7ad687c not modified, skipping...
 ```
 
 ### Sub-command auto-completion

git-issue.1

@@ -208,7 +208,7 @@ Create the issue in the provided GitHub repository.
 .PP
 \fBgit issue export\fP
 .RS 4
-Export issues for the specified project.
+Export modified issues for the specified project.
   Only the issues that have been imported and modified (or created by \fCgit issue create\fP) by \fCgit-issue\fP will be exported.
   With the \fC-e\fP option any escape sequences for the attributes present in the description, will be replaced as above.
   This can be used to e.g. export an unsupported attribute to GitHub as text.
@@ -673,7 +673,6 @@ $ git issue show [Tab]
 7dfa5b7 - An issue entered from the editor
 e6a95c9 - New issue entered from the command line
 
-
 .SH SEE ALSO
 .BR git ( 1 ),
 <\fIhttps://github\.com/dspinellis/git\-issue\fR>

git-issue.sh

@@ -27,7 +27,7 @@
 # User agent string
 # shellcheck disable=SC2034
 # SC2034 : USER_AGENT appears unused. Verify use (or export if used externally)
-USER_AGENT=https://github.com/dspinellis/git-issue/tree/ea66152
+USER_AGENT=https://github.com/dspinellis/git-issue/tree/e643025
 
 # Determine our script library path
 my_IFS=$IFS
@@ -1376,44 +1376,44 @@ usage: git issue <command> [<args>]
 The following commands are available:
 
 Start an issue repository
-   clone      Clone the specified remote repository
-   init       Create a new issues repository in the current directory
+   clone      Clone the specified remote repository.
+   init       Create a new issues repository in the current directory.
 
 Work with an issue
-   new        Create a new open issue (with optional -s summary and -c "provider user repo" for github/gitlab export)
-   show       Show specified issue (and its comments with -c)
-   comment    Add an issue comment
+   new        Create a new open issue (with optional -s summary and -c "provider user repo" for github/gitlab export).
+   show       Show specified issue (and its comments with -c).
+   comment    Add an issue comment.
    edit       Edit the specified issue's (or comment's with -c) description
-   tag        Add (or remove with -r) a tag
-   milestone  Specify (or remove with -r) the issue's milestone
-   weight     Specify (or remove with -r) the issue's weight
-   duedate    Specify (or remove with -r) the issue's due date
-* timeestimate: Specify (or remove with -r) a time estimate for this issue
-   timespent  Specify (or remove with -r) the time spent working on an issue so far
-   assign     Assign (or remove -r) an issue to a person
-   attach     Attach (or remove with -r) a file to an issue
-   watcher    Add (or remove with -r) an issue watcher
+   tag        Add (or remove with -r) a tag.
+   milestone  Specify (or remove with -r) the issue's milestone.
+   weight     Specify (or remove with -r) the issue's weight.
+   duedate    Specify (or remove with -r) the issue's due date.
+* timeestimate: Specify (or remove with -r) a time estimate for this issue.
+   timespent  Specify (or remove with -r) the time spent working on an issue so far.
+   assign     Assign (or remove -r) an issue to a person.
+   attach     Attach (or remove with -r) a file to an issue.
+   watcher    Add (or remove with -r) an issue watcher.
    close      Remove the open tag, add the closed tag
 
 Show multiple issues
-   list       List open issues (or all with -a)
-* list -l formatstring: This will list issues in the specified format, given as an argument to -l
+   list       List open issues (or all with -a).
+* list -l formatstring: This will list issues in the specified format, given as an argument to -l.
 
 Work with multiple issues
-* filter-apply command: Run command in every issue directory The following environment variables will be set:
+* filter-apply command: Run command in every issue directory. The following environment variables will be set:
 
 Synchronize with remote repositories
-   push       Update remote Git repository with local changes
-   pull       Update local Git repository with remote changes
-   import     Import/update GitHub/GitLab issues from the specified project
-   create     Create the issue in the provided GitHub repository
-   export     Export modified issues for the specified project
-   exportall  Export all open issues in the database (-a to include closed ones) to GitHub/GitLab. Useful for cloning whole repositories
+   push       Update remote Git repository with local changes.
+   pull       Update local Git repository with remote changes.
+   import     Import/update GitHub/GitLab issues from the specified project.
+   create     Create the issue in the provided GitHub repository.
+   export     Export modified issues for the specified project.
+   exportall  Export all open issues in the database (-a to include closed ones) to GitHub/GitLab. Useful for cloning whole repositories.
 
 Help and debug
-   help       Display help information about git issue
+   help       Display help information about git issue.
    log        Output a log of changes made
-   git        Run the specified Git command on the issues repository
+   git        Run the specified Git command on the issues repository.
 USAGE_EOF
 }
 

sync-docs.sh

@@ -46,8 +46,6 @@ MAN_PAGE=git-issue.1
     s/git issue //g
     # Remove code markup
     s/`//g
-    # Remove fullstops
-    s/\.//g
     # Format commands, depending on length
     s/^\* ([^:]{3}): /   \1        /g
     s/^\* ([^:]{4}): /   \1       /g

test.sh

@@ -185,21 +185,20 @@ GIT_ISSUE_LIB_PATH="$(pwd)/lib"
 export GIT_ISSUE_LIB_PATH
 
 start sync-docs
-GenFiles="git-issue.sh git-issue.1"
+GenFiles='git-issue.sh git-issue.1'
 if ! git diff --quiet HEAD ; then
   fail "Uncommitted files sync-docs test skipped and pending"
 else
   sh sync-docs.sh --no-user-agent
-  Status=$(git status --porcelain -- "$GenFiles")
+  Status=$(git status --porcelain -- $GenFiles)
   if [ -z "$Status" ]; then
       ok "make sync-docs left $GenFiles as committed"
   else
       fail "make sync-docs changed $GenFiles"
-      git diff -- "$GenFiles" >>"$TopDir/error.log"
-      git checkout -- "$GenFiles"
+      git diff -- $GenFiles >>"$TopDir/error.log"
+      git checkout -- $GenFiles
   fi
 fi
-
 cd "$TopDir"
 
 mkdir testdir