[darcs-users] darcs patch: Migrate SSH_PORT documentation to enviro... (and 1 more)

[Eric Kow]

On Wed, May 13, 2009 at 18:11:07 +1000, Trent W.Buck wrote:
> Wed May 13 17:42:20 EST 2009  Trent W. Buck <trentbuck at gmail.com>
>   * Migrate SSH_PORT documentation to environmentHelp.
> 
> Wed May 13 17:49:30 EST 2009  Trent W. Buck <trentbuck at gmail.com>
>   * Migrate SENDMAIL documentation to environmentHelp.

Applied, thanks!

Migrate SSH_PORT documentation to environmentHelp.
--------------------------------------------------
> Trent W. Buck <trentbuck at gmail.com>**20090513074220
>  Ignore-this: 52940b5abe85fbe87e774c021cc88c42
> ] hunk ./src/Darcs/Commands/Help.lhs 40
>  import Data.Char ( isAlphaNum, toLower )
>  import Data.List (groupBy)
>  import Printer ( text )
> +import Ssh ( environmentHelpSshPort )
>  import System.Exit ( ExitCode(..), exitWith )
>  import ThisVersion ( darcs_version )
>  import Workaround ( getCurrentDirectory )
> hunk ./src/Darcs/Commands/Help.lhs 111
>  
>  -- | Help on each environment variable in which Darcs is interested.
>  environmentHelp :: [([String], [String])]
> -environmentHelp = [environmentHelpHome,
> -                   environmentHelpPager,
> -                   environmentHelpTmpdir,
> -                   environmentHelpKeepTmpdir]
> +environmentHelp = [
> + -- General-purpose
> + environmentHelpHome,
> + environmentHelpPager,
> + environmentHelpTmpdir,
> + environmentHelpKeepTmpdir,
> + -- Remote Repositories
> + environmentHelpSshPort]
>  
>  -- | The rendered form of the data in 'environment_help'.
>  helpOnEnvironment :: String
> hunk ./src/Ssh.hs 3
>  {-# LANGUAGE CPP, ForeignFunctionInterface #-}
>  
> -module Ssh ( grabSSH, runSSH, getSSH, copySSH, copySSHs, SSHCmd(..) ) where
> +module Ssh ( grabSSH, runSSH, getSSH, copySSH, copySSHs, SSHCmd(..), environmentHelpSshPort ) where
>  
>  import Prelude hiding ( lookup, catch )
>  
> hunk ./src/Ssh.hs 225
>       portFlag SCP  x = ["-P", x]
>       portFlag SFTP x = ["-oPort="++x]
>  
> +
> +environmentHelpSshPort :: ([String], [String])
> +environmentHelpSshPort = (["SSH_PORT"], [
> + "If this environment variable is set, it will be used as the port",
> + "number for all SSH calls made by Darcs (when accessing remote",
> + "repositories over SSH).  This is useful if your SSH server does not",
> + "run on the default port, and your SSH client does not support",
> + "ssh_config(5).  OpenSSH users will probably prefer to put something",
> + "like `Host *.example.net Port 443' into their ~/.ssh/config file."])
> +
>  -- | Return True if this version of ssh has a ControlMaster feature
>  -- The ControlMaster functionality allows for ssh multiplexing
>  hasSSHControlMaster :: Bool
> hunk ./src/configuring_darcs.tex 98
>  \darcsEnv{DARCS_KEEP_TMPDIR}
>  \darcsEnv{HOME}
>  
> -\paragraph{TERM}
> -\label{env:TERM}
> -If darcs is compiled with libcurses support and support for color output,
> -it uses the environment variable TERM to decide whether or not color is
> -supported on the output terminal.
> -
>  \section{Remote repositories}
> hunk ./src/configuring_darcs.tex 99
> -
> -\paragraph{SSH\_PORT}
> -\label{env:SSH_PORT}
> -When using ssh, if the SSH\_PORT environment variable is defined, darcs will
> -use that port rather than the default ssh port (which is 22).
> +\darcsEnv{SSH_PORT}
>  
>  \paragraph{DARCS\_SSH}
>  \label{env:DARCS_SSH}

Migrate SENDMAIL documentation to environmentHelp.
--------------------------------------------------
> Trent W. Buck <trentbuck at gmail.com>**20090513074930
>  Ignore-this: 33f84f34137d1386002fb9e5b0f785ae
> ] hunk ./src/Darcs/Arguments.lhs 47
>                           recursive, inventory_choices, get_inventory_choices,
>                           askdeps, ignoretimes, lookforadds,
>                           ask_long_comment, sendmail_cmd,
> +                         environmentHelpSendmail,
>                           sign, verify, edit_description,
>                           reponame, tagname, creatorhash,
>                           apply_conflict_options, reply,
> hunk ./src/Darcs/Arguments.lhs 1282
>  \begin{options}
>  --sendmail-command
>  \end{options}
> -
> -\label{env:SENDMAIL}
> -
> -Several commands send email. The user can determine which mta to
> -use with the \verb!--sendmail-command! switch. For repetitive usage
> -of a specific sendmail command it is also possible to set the
> -environment variable \verb!SENDMAIL!. If there is no command line
> -switch given \verb!SENDMAIL! will be used if present.
> +\darcsEnv{SENDMAIL}
>  
>  \begin{code}
>  sendmail_cmd = DarcsArgOption [] ["sendmail-command"] SendmailCmd "COMMAND" "specify sendmail command"
> hunk ./src/Darcs/Arguments.lhs 1287
>  
> +environmentHelpSendmail :: ([String], [String])
> +environmentHelpSendmail = (["SENDMAIL"], [
> + "On Unix, the `darcs send' command relies on sendmail(8).  The",
> + "`--sendmail-command' or $SENDMAIL environment variable can be used to",
> + "provide an explicit path to this program; otherwise the standard",
> + "locations /usr/sbin/sendmail and /usr/lib/sendmail will be tried."])
> +-- FIXME: mention the following also:
> +-- * sendmail(8) is not sendmail-specific;
> +-- * nowadays, desktops often have no MTA or an unconfigured MTA --
> +--   which is awful, because it accepts mail but doesn't relay it;
> +-- * in this case, can be a sendmail(8)-emulating wrapper on top of an
> +--   MUA that sends mail directly to a smarthost; and
> +-- * on a multi-user system without an MTA and on which you haven't
> +--   got root, can be msmtp.
> +
>  -- |'get_sendmail_cmd' takes a list of flags and returns the sendmail command
>  -- to be used by @darcs send at . Looks for a command specified by
>  -- @SendmailCmd \"command\"@ in that list of flags, if any.
> hunk ./src/Darcs/Commands/Help.lhs 28
>   print_version,
>   list_available_commands ) where
>  
> -import Darcs.Arguments ( DarcsFlag(..) )
> +import Darcs.Arguments ( DarcsFlag(..), environmentHelpSendmail )
>  import Darcs.Commands (
>   CommandArgs(..), CommandControl(..), DarcsCommand(..),
>   disambiguate_commands, extract_commands, get_command_help, nodefaults, usage )
> hunk ./src/Darcs/Commands/Help.lhs 117
>   environmentHelpPager,
>   environmentHelpTmpdir,
>   environmentHelpKeepTmpdir,
> + environmentHelpSendmail,
>   -- Remote Repositories
>   environmentHelpSshPort]
>  
> 

-- 
Eric Kow <http://www.nltg.brighton.ac.uk/home/Eric.Kow>
PGP Key ID: 08AC04F9
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 194 bytes
Desc: not available
URL: <http://lists.osuosl.org/pipermail/darcs-users/attachments/20090513/df09f675/attachment-0001.pgp>