Skip to content

Commit

Permalink
Documentation editing and improvements
Browse files Browse the repository at this point in the history
Some formatting and more explanatory text. Frost was missing from the
rcm(7) credits. While here, bump the version number.

Honestly I just had these edits sitting around, unsure for how long.
  • Loading branch information
mike-burns committed Apr 8, 2015
1 parent 33ff11e commit 45071a8
Show file tree
Hide file tree
Showing 8 changed files with 43 additions and 10 deletions.
1 change: 1 addition & 0 deletions .mailmap
Expand Up @@ -5,3 +5,4 @@ Melissa Xie <melissa@thoughtbot.com> <me@melissaxie.com>
Mike Burns <mburns@thoughtbot.com> <mike@mike-burns.com>
Pablo Olmos de Aguilera Corradini <pablo@glatelier.org>
Patrick Brisbin <pat@thoughtbot.com> <pbrisbin@gmail.com>
Martin Frost <frost@ceri.se> <martin@frost.ws>
2 changes: 1 addition & 1 deletion configure.ac
Expand Up @@ -2,7 +2,7 @@
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.69])
AC_INIT(rcm, 1.2.3, mburns@thoughtbot.com)
AC_INIT(rcm, 1.2.4, mburns@thoughtbot.com)
AM_INIT_AUTOMAKE

# Checks for programs.
Expand Down
16 changes: 15 additions & 1 deletion man/lsrc.1
Expand Up @@ -175,8 +175,22 @@ User configuration file. Defaults to
.Xr rcrc 5 ,
.Xr rcm 7
.Sh AUTHORS
.An "Mike Burns" Aq mike@mike-burns.com
.Nm
is maintained by
.An "Mike Burns" Aq Mt mburns@thoughtbot.com
and
.Lk http://thoughtbot.se thoughtbot
.Sh BUGS
For OS X systems, we strongly encourage the use of the
.Va HOSTNAME
variable in your
.Xr rcrc 5 .
We use the
.Xr hostname 1
program to determine the unique identifier for the host. This program is
not specified by POSIX and can vary by system. On OS X the hostname is
unpredictable, and can even change as part of the DHCP handshake.
.Pp
There are a few bugs around shell globs. Anything involving an exclude
pattern is unpredictable, so use
.Fl v
Expand Down
6 changes: 5 additions & 1 deletion man/mkrc.1
Expand Up @@ -80,4 +80,8 @@ User configuration file. Defaults to
.Xr rcrc 5 ,
.Xr rcm 7
.Sh AUTHORS
.An "Mike Burns" Aq mike@mike-burns.com
.Nm
is maintained by
.An "Mike Burns" Aq Mt mburns@thoughtbot.com
and
.Lk http://thoughtbot.se thoughtbot
9 changes: 7 additions & 2 deletions man/rcdn.1
Expand Up @@ -41,7 +41,8 @@ The
program will run hooks before and after removing files, if these hooks
exist. Hooks are executable programs inside the dotfiles directory, with
the following names:
.Pa hooks/pre-down and
.Pa hooks/pre-down
and
.Pa hooks/post-down .
These hooks are run each time
.Nm
Expand Down Expand Up @@ -148,4 +149,8 @@ User configuration file. Defaults to
.Xr rcrc 5 ,
.Xr rcm 7
.Sh AUTHORS
.An "Mike Burns" Aq mike@mike-burns.com
.Nm
is maintained by
.An "Mike Burns" Aq Mt mburns@thoughtbot.com
and
.Lk http://thoughtbot.se thoughtbot
1 change: 1 addition & 0 deletions man/rcm.7.mustache
Expand Up @@ -136,6 +136,7 @@ in
or use the
.Fl U
option. For example:
.Pp
.Dl mkrc -U bin
.
.Sh QUICK START FOR EMPTY DOTFILES DIRECTORIES
Expand Down
8 changes: 6 additions & 2 deletions man/rcrc.5
Expand Up @@ -37,7 +37,7 @@ the source directories for dotfiles. The first in the list is the
source to which dotfiles created using
.Xr mkrc 1
are installed. The default value is
.Li ~/.dotfiles
.Pa ~/.dotfiles
.
.It Va EXCLUDES
a space-separated list of exclude patterns. Exclude patterns are
Expand Down Expand Up @@ -91,4 +91,8 @@ under the section
.Xr rcup 1 ,
.Xr rcm 7
.Sh AUTHORS
.An "Mike Burns" Aq mike@mike-burns.com
.Nm
is maintained by
.An "Mike Burns" Aq Mt mburns@thoughtbot.com
and
.Lk http://thoughtbot.se thoughtbot
10 changes: 7 additions & 3 deletions man/rcup.1
Expand Up @@ -156,8 +156,8 @@ Host-specific files go in a directory named for the host, prefixed with
For example,
.Pa .dotfiles/host-scarlett
contains files specific to the computer with hostname
.Pa scarlett
, and these files will only be installed on the computer with hostname
.Pa scarlett ,
and these files will only be installed on the computer with hostname
.Pa scarlett .
.Pp
Tagged files go in a directory named for the tag, prefixed with
Expand Down Expand Up @@ -249,4 +249,8 @@ User configuration file. Defaults to
.Xr rcrc 5 ,
.Xr rcm 7
.Sh AUTHORS
.An "Mike Burns" Aq mike@mike-burns.com
.Nm
is maintained by
.An "Mike Burns" Aq Mt mburns@thoughtbot.com
and
.Lk http://thoughtbot.se thoughtbot

0 comments on commit 45071a8

Please sign in to comment.