Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct spelling mistakes. #66

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion TODO.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
TODO
====

- deployement solution
- deployment solution
- add ui to admin gaffer
2 changes: 1 addition & 1 deletion docs/applications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Gaffer applications
===================

Gaffer applications are applications that are started by the manager. A
gaffer application can be used to interract with the manager or
gaffer application can be used to interact with the manager or
listening on events.

An application is a class with the following structure::
Expand Down
2 changes: 1 addition & 1 deletion docs/gaffer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ SUBCOMMANDS
folder.

**ps** [<appname>]
List your processes informations
List your processes information

<appname> he name of the application (session) of process
recoreded in gafferd. By default it will be the name of your
Expand Down
2 changes: 1 addition & 1 deletion docs/gafferpm_ext.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
load Load a Procfile application to gafferd
unload Unload a Procfile application to gafferd
scale Scaling your process
ps List your process informations
ps List your process information
help Get help on a command
"""

Expand Down
10 changes: 5 additions & 5 deletions docs/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,17 +103,17 @@ parameters are:

- **cmd**: the full command line to launch. eg. ``./dummy.p¨``
- **args**: arguments to pass as a string. eg. ``-some value --option=a``
- **cwd**: path to working directorty
- **cwd**: path to working directory
- **uid**: user name or id used to execute the process
- **gid**: group name or id used to execute the process
- **detach**: if you wnt to completely detach the process from gafferd
(gaffer will still continue to supervise it)
- **shell**: The process is executed in a shell (unix only)
- **flapping**: flapping rule. eg. `2, 1., 7., 5` which means
attempts=2, window=1., retry_in=7., max_retry=5
- **redirect_input**: to allows you to interract with stdin
- **redirect_input**: to allows you to interact with stdin
- **redirect_output**: to watch both stdout & stderr. output names can
be whatever you cant. For example you. eg. ``redirect_output =
be whatever you want. For example you. eg. ``redirect_output =
mystdout, mystderr`` stdout will be labelled *mysdtout* in this
case.
- **graceful_timeout**: time to wait before definitely kill a process.
Expand All @@ -128,7 +128,7 @@ parameters are:
processes have the same order.


Sometimes you also want to pass a custom environnement to your process.
Sometimes you also want to pass a custom environment to your process.
This is done by creating a special configuration section named
``env:processname``. Each environmenets sections are prefixed by
``env:``. For example to pass a special PORT environment variable to
Expand Down Expand Up @@ -195,7 +195,7 @@ and then scale them up and down::

.. image:: _static/gaffer_ps.png

have a look on the :doc:`gaffer` page for more informations about the
have a look on the :doc:`gaffer` page for more information about the
commands.


Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Features
a gaffer node from any browser or SOCKJS client.
- Framework to manage and interact your applications and jobs on
differerent machines
- Server and :doc:`command-line` tools to manage and interract with your
- Server and :doc:`command-line` tools to manage and interact with your
processes
- manages topology information. Clients query gaffer_lookupd to discover
gaffer nodes for a specific job or application.
Expand Down
4 changes: 2 additions & 2 deletions docs/news.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ CHANGES

- new intermediary release.
See https://github.com/benoitc/gaffer/compare/0.4.4...0.5.0 for a
detailled changelog.
detailed changelog.


2012/12/20 - version 0.4.4
Expand All @@ -33,7 +33,7 @@ CHANGES
2012/10/29 - version 0.4.0
--------------------------

- add environent variables support in the gafferd setting file.
- add environment variables support in the gafferd setting file.
- add a plugin system to easily extend :doc:`gafferd` using HTML sites
or gaffer applications in Python

Expand Down
8 changes: 4 additions & 4 deletions docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Current properties for each template:
and try to spawn them
- **max_retry**: maximum number of retry before we give up
and stop the process.
- **redirect_output**: list of io to redict (max 2) this is a list of custom
- **redirect_output**: list of io to redirect (max 2) this is a list of custom
labels to use for the redirection. Ex: ["a", "b"] will
redirect stdoutt & stderr and stdout events will be labeled "a"
- **redirect_input**: Boolean (False is the default). Set it if
Expand Down Expand Up @@ -130,7 +130,7 @@ Watch stats
-----------

Stats of a process can be monitored continuously (there is a refresh
interval of 0.1s to fetch CPU informations) using the following
interval of 0.1s to fetch CPU information) using the following
method::

manager.monitor(<nameorid>, <listener>)
Expand Down Expand Up @@ -237,7 +237,7 @@ write at the same time. This method is threadsafe.
HTTP API
--------

See the :doc:`HTTP api description <http>` for more informations.
See the :doc:`HTTP api description <http>` for more information.

Tools
-----
Expand All @@ -248,4 +248,4 @@ processes without having to code. It can be used like `supervisor
<http://smarden.org/runit/>`_ or other tools around. Speaking of runit
a similar controlling will be available in 0.2 .

See the :doc:`command-line` documentation for more informations.
See the :doc:`command-line` documentation for more information.
2 changes: 1 addition & 1 deletion examples/sockjs/chat/chat_console.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def on_input(self, handle, data, err):
class ChatReader(WebSocket):

def on_open(self):
print("connection openned")
print("connection opened")
self.console = Input(self)

def on_message(self, data):
Expand Down
2 changes: 1 addition & 1 deletion gaffer/cli/commands/key.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def run(self, config, args):
permissions = key.get('permissions', {})
print("Key %r found." % args['<apikey>'])
print("Label: %s" % key.get("label", ""))
print("Permisssions:")
print("Permissions:")
display_permissions(permissions)

def display_permissions(permissions):
Expand Down
2 changes: 1 addition & 1 deletion gaffer/cli/commands/ps.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class Ps(Command):
"""

name = "ps"
short_descr = "list your processes informations"
short_descr = "list your processes information"

def run(self, config, args):
balance = copy.copy(GAFFER_COLORS)
Expand Down
4 changes: 2 additions & 2 deletions gaffer/console_output.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
class Color(object):
""" wrapper around colorama to ease the output creation. Don't use
it directly, instead, use the ``colored(name_of_color, lines)`` to
return the colored ouput.
return the colored output.

Colors are: cyan, yellow, green, magenta, red, blue,
intense_cyan, intense_yellow, intense_green, intense_magenta,
Expand All @@ -43,7 +43,7 @@ class Color(object):
"""

def __init__(self):
# intialize colors code
# initialize colors code
colors = {}
for color in GAFFER_COLORS:
c = color.upper()
Expand Down
2 changes: 1 addition & 1 deletion gaffer/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ def publish(self, evtype, *args, **kwargs):
self._dispatch_event()

def subscribe(self, evtype, listener, once=False):
""" subcribe to an event """
""" subscribe to an event """

if evtype == ".": # wildcard
self._wildcards.add((once, listener))
Expand Down
2 changes: 1 addition & 1 deletion gaffer/gafferd/http.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ def __init__(self, config, plugin_manager=None, **settings):

self.clients = dict()

# intialize the config
# initialize the config
self.init_config()


Expand Down
2 changes: 1 addition & 1 deletion gaffer/gafferd/keys.py
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ def __init__(self, loop, cfg):
if self.dbname != ":memory:":
self.dbname = os.path.join(cfg.config_dir, self.dbname)

# intitialize conn
# initialize conn
self.conn = None

def open(self):
Expand Down
2 changes: 1 addition & 1 deletion gaffer/gafferd/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ def run(self):
# initialize the plugin manager
self.plugin_manager = PluginManager(self.cfg.plugin_dir)

# check if any plugin dependancy is missing
# check if any plugin dependency is missing
self.plugin_manager.check_mandatory()

# initialize the manager
Expand Down
6 changes: 3 additions & 3 deletions gaffer/gafferd/users.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class UserNotFound(Exception):


class UserConflict(Exception):
""" exception raised when you try to create an already exisiting user """
""" exception raised when you try to create an already existing user """

class User(object):
""" instance representing an authenticated user """
Expand Down Expand Up @@ -165,7 +165,7 @@ def _check_password(self, a, b):
if len(a) != len(b):
return False

# do a binary comparaison of password hashes
# do a binary comparison of password hashes
rv = 0
for x, y in zip(a, b):
rv |= ord(x) ^ ord(y)
Expand Down Expand Up @@ -246,7 +246,7 @@ def __init__(self, loop, cfg):
if self.dbname != ":memory:":
self.dbname = os.path.join(cfg.config_dir, self.dbname)

# intitialize conn
# initialize conn
self.conn = None

def open(self):
Expand Down
2 changes: 1 addition & 1 deletion gaffer/lookupd/registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class IdentExists(Exception):
"""

class AlreadyRegistered(Exception):
""" exception raised when a job is alreay registered """
""" exception raised when a job is already registered """


class RemoteJob(object):
Expand Down
12 changes: 6 additions & 6 deletions gaffer/manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# This file is part of gaffer. See the NOTICE for more information.
"""
The manager module is a core component of gaffer. A Manager is
responsible of maintaining processes and allows you to interract with
responsible of maintaining processes and allows you to interact with
them.

Classes
Expand Down Expand Up @@ -109,7 +109,7 @@ def start(self, apps=[]):
# manage processes
self.events.subscribe('exit', self._on_exit)

# start contollers
# start controllers
for mapp in self.mapps:
mapp.start(self.loop, self)

Expand Down Expand Up @@ -279,7 +279,7 @@ def unload(self, name_or_process, sessionid=None):
self._stopall(state)

def reload(self, name, sessionid=None):
""" reload a process config. The number of processes is resetted to
""" reload a process config. The number of processes is reset to
the one in settings and all current processes are killed """

if not sessionid:
Expand Down Expand Up @@ -396,7 +396,7 @@ def scale(self, name, n):
m.scale("sometemplate", -1) # decrease of 1
m.scale("sometemplate", "+1") # increase of 1
m.scale("sometemplate", "-1") # decrease of 1
m.scale("sometemplate", "=1") # set the number of processess to 1
m.scale("sometemplate", "=1") # set the number of processes to 1
"""
sessionid, name = self._parse_name(name)
pname = "%s.%s" % (sessionid, name)
Expand Down Expand Up @@ -738,7 +738,7 @@ def _shutdown(self):
# h.close()
#self.loop.walk(walk_cb)

# if there any stop callback, excute it
# if there any stop callback, execute it
if self.stop_cb is not None:
self.stop_cb(self)
self.stop_cb = None
Expand Down Expand Up @@ -900,7 +900,7 @@ def _reap_processes(self, state):
# graceful time
self._tracker.check(p, state.graceful_timeout)

# notify others that the process is beeing reaped
# notify others that the process is being reaped
self._publish("reap", name=p.name, pid=p.pid, os_pid=p.os_pid)
self._publish("job.%s.reap" % p.name, name=p.name, pid=p.pid,
os_pid=p.os_pid)
Expand Down
4 changes: 2 additions & 2 deletions gaffer/message.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class Message(object):
V1 type messageid\0body

This simple messaging protocol allows us to pass any kind of blob as a
body and eventually a json while still beeing able to know the type of the
body and eventually a json while still being able to know the type of the
message.
"""

Expand Down Expand Up @@ -60,7 +60,7 @@ def decode_frame(cls, frame):
# the magic bit.
_, type, id = header.split()

# return the message classe
# return the message class
return cls(body, id=id, type=type)
except ValueError:
raise MessageError("invalid message %r" % frame)
Expand Down
12 changes: 6 additions & 6 deletions gaffer/process.py
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ def refresh(self, interval=0):
def _start(self):
if not self.active:
self._timer = pyuv.Timer(self.loop)
# start the timer to refresh the informations
# start the timer to refresh the information
# 0.1 is the minimum interval to fetch cpu stats for this
# process.
self._timer.start(self._async_refresh, 0.1, 0.1)
Expand Down Expand Up @@ -291,7 +291,7 @@ def __init__(self, name, cmd, **settings):
Settings:

- **args**: the arguments for the command to run. Can be a list or
a string. If **args** is a string, it's splitted using
a string. If **args** is a string, it's split using
:func:`shlex.split`. Defaults to None.
- **env**: a mapping containing the environment variables the command
will run with. Optional
Expand All @@ -314,7 +314,7 @@ def __init__(self, name, cmd, **settings):
and try to spawn them
- **max_retry**: maximum number of retry before we give up
and stop the process.
- **redirect_output**: list of io to redict (max 2) this is a list of custom
- **redirect_output**: list of io to redirect (max 2) this is a list of custom
labels to use for the redirection. Ex: ["a", "b"] will
redirect stdout & stderr and stdout events will be labeled "a"
- **redirect_input**: Boolean (False is the default). Set it if
Expand Down Expand Up @@ -415,7 +415,7 @@ class Process(object):
- **name**: name of the process
- **cmd**: program command, string)
- **args**: the arguments for the command to run. Can be a list or
a string. If **args** is a string, it's splitted using
a string. If **args** is a string, it's split using
:func:`shlex.split`. Defaults to None.
- **env**: a mapping containing the environment variables the command
will run with. Optional
Expand All @@ -426,7 +426,7 @@ class Process(object):
won't exit when the manager is stopped.
- **shell**: boolean, run the script in a shell. (UNIX
only)
- **redirect_output**: list of io to redict (max 2) this is a list of custom
- **redirect_output**: list of io to redirect (max 2) this is a list of custom
labels to use for the redirection. Ex: ["a", "b"] will
redirect stdoutt & stderr and stdout events will be labeled "a"
- **redirect_input**: Boolean (False is the default). Set it if
Expand Down Expand Up @@ -602,7 +602,7 @@ def os_pid(self):
@property
def info(self):
""" return the process info. If the process is monitored it
return the last informations stored asynchronously by the watcher"""
return the last information stored asynchronously by the watcher"""

# info we have on this process
if self._info is None:
Expand Down
4 changes: 2 additions & 2 deletions gaffer/webhooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# This file is part of gaffer. See the NOTICE for more information.
"""
Webhooks allow to register an url to a specific event (or alls) and the
Webhooks allow to register an url to a specific event (or all) and the
event will be posted on this URL. Each events can triger a post on a
given url.

Expand All @@ -12,7 +12,7 @@
[webhooks]
create = http://echohttp.com/echo you

Or programatically::
Or programmatically::

from gaffer.manager import Manager
from gaffer.webhooks import WebHooks
Expand Down