Fix some spelling errors (#3450)

Signed-off-by: Elyes HAOUAS <ehaouas@noos.fr>

awesomeConfig.cmake

@@ -244,7 +244,7 @@ else()
     set(SYSCONFDIR ${CMAKE_INSTALL_PREFIX}/etc CACHE PATH "config directory")
 endif()
 
-#If an XDG Config Dir is specificed, use it instead
+#If an XDG Config Dir is specified, use it instead
 #of the default XDG configuration dir.
 if(DEFINED XDG_CONFIG_DIR)
     set(XDG_CONFIG_DIR ${XDG_CONFIG_DIR} CACHE PATH "xdg config directory")

color.c

@@ -110,7 +110,7 @@ apply_mask(uint8_t component, uint32_t mask)
  * \param colstr Color specification.
  * \param len The length of colstr (which still MUST be NULL terminated).
  * \param visual The visual for which the color is to be allocated.
- * \return request informations.
+ * \return request information.
  */
 color_init_request_t
 color_init_unchecked(color_t *color, const char *colstr, ssize_t len, xcb_visualtype_t *visual)

lib/awful/_compat.lua

@@ -80,7 +80,7 @@ function root.wallpaper(pattern)
 end
 
 
--- root.bottons() used to be a capi function. However this proved confusing
+-- root.buttons() used to be a capi function. However this proved confusing
 -- as rc.lua used `awful.button` and `root.buttons()` used capi.button. There
 -- was a little documented hack to "flatten" awful.button into a pair of
 -- capi.button. A consequence of this, beside being ugly, was that it was

lib/awful/client.lua

@@ -1200,7 +1200,7 @@ end
 --- If the client is dockable.
 --
 -- A dockable client is an application confined to the edge of the screen. The
--- space it occupies is substracted from the `screen.workarea`.
+-- space it occupies is subtracted from the `screen.workarea`.
 --
 -- Clients with a type of "utility", "toolbar" or "dock" are dockable by
 -- default.
@@ -1359,7 +1359,7 @@ end
 
 --- Switch to a client matching the given condition if running, else spawn it.
 -- If multiple clients match the given condition then the next one is
--- focussed.
+-- focused.
 --
 -- @tparam string cmd the command to execute
 -- @tparam function matcher a function that returns true to indicate a matching client
@@ -1674,7 +1674,7 @@ end)
 --- The last geometry when client was floating.
 -- @signal property::floating_geometry
 
---- Emited when a client need to get a titlebar.
+--- Emitted when a client need to get a titlebar.
 -- @signal request::titlebars
 -- @tparam[opt=nil] string content The context (like "rules")
 -- @tparam[opt=nil] table hints Some hints.
@@ -1686,7 +1686,7 @@ end)
 --- The client unmarked signal.
 -- @deprecatedsignal unmarked
 
---- Emited when the border client might need to be update.
+--- Emitted when the border client might need to be update.
 --
 -- The context are:
 --

lib/awful/key.lua

@@ -359,7 +359,7 @@ end
 --        {"Down"  , "Down"  },
 --    }
 --
--- This table is acessed internally by Awesome. Users will usually use key
+-- This table is accessed internally by Awesome. Users will usually use key
 -- bindings with the property `keygroup` instead of accessing this table
 -- directly.
 -- @name awful.key.keygroups

lib/awful/keygrabber.lua

@@ -27,7 +27,7 @@
 -- Using keygrabber for modal keybindings (VI like)
 -- ------------------------------------------------
 --
--- VI-like modal keybindings are trigerred by a key, like `Escape`, followed by
+-- VI-like modal keybindings are triggered by a key, like `Escape`, followed by
 -- either a number, an adjective (or noun) and closed by a verb. For example
 -- `<Escape>+2+t+f` could mean "focus (f) the second (2) tag (t)".
 -- `<Escape>+2+h+t+f` would "focus (f) two (2) tags (t) to the right (h)".
@@ -376,7 +376,7 @@ end
 -- keygrabber. It helps save some boilerplate code in the handler callbacks.
 --
 -- It is useful when a transaction only handle a limited number of keys. If
--- a key unhandled by the transaction is trigerred, the transaction is
+-- a key unhandled by the transaction is triggered, the transaction is
 -- canceled.
 --
 -- @DOC_text_awful_keygrabber_allowed_keys_EXAMPLE@
@@ -403,7 +403,7 @@ end
 -- The keygrabber instance is created when the keygrabber starts. It is an object
 -- mirroring this keygrabber object, but where extra properties can be added. It
 -- is useful to keep some contextual data part of the current transaction without
--- poluting the original object of having extra boilerplate code.
+-- polluting the original object of having extra boilerplate code.
 --
 -- @tfield keygrabber current_instance
 -- @emits property::current_instance
@@ -448,7 +448,7 @@ function keygrabber:start()
 
     self.grabber = keygrab.run(function(...) return runner(self, ...) end)
 
-    -- Ease making keygrabber that wont hang forever if no action is taken.
+    -- Ease making keygrabber that won't hang forever if no action is taken.
     if self.timeout and not self._private.timer then
         self._private.timer = gtimer {
             timeout     = self.timeout,
@@ -603,7 +603,7 @@ end
 -- @tparam table self The current transaction object.
 -- @tparam string stop_key The key(s) that stop the keygrabbing (if any)
 -- @tparam table stop_mods The modifiers key (if any)
--- @tparam sting sequence The recorded key sequence.
+-- @tparam string sequence The recorded key sequence.
 -- @callback stop_callback
 -- @see sequence
 -- @see stop
@@ -661,7 +661,7 @@ end
 -- @tparam[opt] function args.keypressed_callback
 -- @tparam[opt] function args.keyreleased_callback
 -- @tparam[opt=nil] table|nil args.allowed_keys A table with all keys that
---  **wont** stop the keygrabber.
+--  **won't** stop the keygrabber.
 -- @tparam[opt] table args.root_keybindings The root (global) keybindings.
 -- @tparam[opt=false] boolean args.export_keybindings Create root (global) keybindings.
 -- @tparam[opt=false] boolean args.autostart Start the grabbing immediately

lib/awful/layout/init.lua

@@ -433,7 +433,7 @@ init_layouts = function()
     init_layouts = nil
 end
 
--- "new" is emited before "activate", do it should be the very last opportunity
+-- "new" is emitted before "activate", do it should be the very last opportunity
 -- generate the list of default layout. With dynamic tag, this can happen later
 -- than the first event loop iteration.
 capi.tag.connect_signal("new", init_layouts)

lib/awful/layout/suit/corner.lua

@@ -33,7 +33,7 @@ local capi = {screen = screen}
 -- @see gears.surface
 
 -- Actually arrange clients of p.clients for corner layout
--- @param p Mandatory table containing required informations for layouts
+-- @param p Mandatory table containing required information for layouts
 -- (clients to arrange, workarea geometry, etc.)
 -- @param orientation String indicating in which corner is the master window.
 -- Available values are : NE, NW, SW, SE
@@ -81,7 +81,7 @@ local function do_corner(p, orientation)
         column.x = wa.x
     end
     -- At this point, master is in a corner
-    -- but row and column are overlayed in the opposite corner...
+    -- but row and column are overlaied in the opposite corner...
 
     -- Reduce the unprivileged slaves to remove overlay
     -- and define actual width and height

lib/awful/menu.lua

@@ -673,7 +673,7 @@ end
 --------------------------------------------------------------------------------
 
 --- Create a menu popup.
--- @param args Table containing the menu informations.
+-- @param args Table containing the menu information.
 --
 -- * Key items: Table containing the displayed items. Each element is a table by default (when element 'new' is
 --   awful.menu.entry) containing: item name, triggered action (submenu table or function), item icon (optional).

lib/awful/placement.lua

@@ -115,7 +115,7 @@ local attach
 --- Allow multiple placement functions to be daisy chained.
 -- This also allow the functions to be aware they are being chained and act
 -- upon the previous nodes results to avoid unnecessary processing or deduce
--- extra paramaters/arguments.
+-- extra parameters/arguments.
 local function compose(...)
     local queue = {}
 
@@ -144,7 +144,7 @@ local function compose(...)
         local last_geo = nil
 
         -- As some functions may have to take into account results from
-        -- previously execued ones, add the `composition_results` hint.
+        -- previously executed ones, add the `composition_results` hint.
         args = setmetatable({composition_results=rets}, {__index=args})
 
         -- Only apply the geometry once, not once per chain node, to do this,
@@ -341,7 +341,7 @@ local function get_decoration(args)
         height = offset,
     } or args.offset or {}
 
-    -- Margins are distances on each side to substract from the area`
+    -- Margins are distances on each side to subtract from the area`
     local m = type(args.margins) == "table" and args.margins or {
         left = args.margins or 0 , right  = args.margins or 0,
         top  = args.margins or 0 , bottom = args.margins or 0
@@ -516,7 +516,7 @@ wibox_update_strut = function(d, position, args)
 
     for _, v in ipairs(struts_orientation_to_sides[orientation]) do
         if (not position) or position:match(v) then
-            -- Add the "short" rectangle lenght then the above and below margins.
+            -- Add the "short" rectangle length then the above and below margins.
             struts[v] = geo[opposites[orientation_to_length[orientation]]]
                 + m[v]
                 + m[opposites[v]]
@@ -1476,8 +1476,8 @@ end
 -- @tparam string|table args.preferred_anchors The preferred anchor(s) (in order)
 -- @tparam string args.geometry A geometry inside the other drawable
 -- @treturn table The new geometry
--- @treturn string The choosen position ("left", "right", "top" or "bottom")
--- @treturn string The choosen anchor ("front", "middle" or "back")
+-- @treturn string The chosen position ("left", "right", "top" or "bottom")
+-- @treturn string The chosen anchor ("front", "middle" or "back")
 -- @staticfct awful.placement.next_to
 function placement.next_to(d, args)
     args = add_context(args, "next_to")
@@ -1647,7 +1647,7 @@ function placement.restore(d, args)
     return true
 end
 
---- Skip all preceeding results of placement pipeline for fullscreen clients.
+--- Skip all preceding results of placement pipeline for fullscreen clients.
 --@DOC_awful_placement_skip_fullscreen_EXAMPLE@
 -- @tparam drawable d A drawable (like `client`, `mouse` or `wibox`)
 -- @tparam[opt={}] table args Other arguments

lib/awful/prompt.lua

@@ -59,7 +59,7 @@
 --
 -- The Awesome prompt also supports adding custom extensions to specific
 -- keyboard keybindings. Those keybindings have precedence over the built-in
--- ones. Therefor, they can be used to override the default ones.
+-- ones. Therefore, they can be used to override the default ones.
 --
 -- *[Example one] Adding pre-configured `awful.spawn` commands:*
 --

lib/awful/screen.lua

@@ -32,7 +32,7 @@ local screen = {object={}}
 local data = {}
 data.padding = {}
 
---- Take an input geometry and substract/add a delta.
+--- Take an input geometry and subtract/add a delta.
 -- @tparam table geo A geometry (width, height, x, y) table.
 -- @tparam table delta A delta table (top, bottom, x, y).
 -- @treturn table A geometry (width, height, x, y) table.
@@ -862,7 +862,7 @@ end
 --
 -- Important: This only exists when Awesome is started with `--screen off`.
 --
--- Note that given the viewports are not the same, the `id` wont be the same.
+-- Note that given the viewports are not the same, the `id` won't be the same.
 -- Also note that if multiple new viewports fit within a single "old" viewport,
 -- the resized screen will be the one with the largest total overlapping
 -- viewport (`intersection.width*intersection.height`), regardless of the
@@ -970,7 +970,7 @@ require("awful.screen.dpi")(screen, data)
 -- Set the wallpaper(s) and create the bar(s) for new screens
 
 capi.screen.connect_signal("_added", function(s)
-    -- If it was emited from here when screens are created with fake_add,
+    -- If it was emitted from here when screens are created with fake_add,
     -- the Lua code would not have an opportunity to polutate the screen
     -- metadata. Thus, the DPI may be wrong when setting the wallpaper.
     if s._managed ~= "Lua" then

lib/awful/spawn.lua

@@ -6,7 +6,7 @@
 -- This module provides methods to start programs and supports startup
 -- notifications, which allows for callbacks and applying properties to the
 -- program after it has been launched.  This requires currently that the
--- applicaton supports them.
+-- application supports them.
 --
 -- Frequently asked questions
 -- ===
@@ -59,7 +59,7 @@
 --
 -- If you want to update the text of a `wibox.widget.textbox` with the output
 -- of a shell command, you should use the `awful.spawn.easy_async_with_shell`
--- command. It is strongly recommanded not to use `io.popen` is explained in the
+-- command. It is strongly recommended not to use `io.popen` is explained in the
 -- "Getting a command's output" section. Asynchronous execution is at first a
 -- bit tricky to understand if you never used that before. The example below
 -- should demonstrate how it works.
@@ -72,7 +72,7 @@
 --
 -- The label will display `foo`. But If we do:
 --
---     -- Don't do this, it wont work.
+--     -- Don't do this, it won't work.
 --     -- Assumes /tmp/foo.txt does not exist
 --     awful.spawn.with_shell("sleep 1; echo foo > /tmp/foo.txt")
 --     mylabel.text = io.popen("cat /tmp/foo.txt"):read("*all")
@@ -97,7 +97,7 @@
 -- In this variant, Awesome will not block. Again, like other spawn, you
 -- cannot add code outside of the callback function to use the result of the
 -- command. The code will be executed before the command is finished so the
--- result wont yet be available.
+-- result won't yet be available.
 --
 -- **Getting a command's output**:
 --
@@ -640,7 +640,7 @@ end
 --
 -- This function depends on the startup notification protocol to be correctly
 -- implemented by the command. See `client.startup_id` for more information.
--- Note that this also wont work with shell or terminal commands.
+-- Note that this also won't work with shell or terminal commands.
 --
 -- @tparam string|table cmd The command.
 -- @tparam[opt] table rules The properties that need to be applied to the client.
@@ -670,7 +670,7 @@ end
 --
 -- This function depends on the startup notification protocol to be correctly
 -- implemented by the command. See `client.startup_id` for more information.
--- Note that this also wont work with shell or terminal commands.
+-- Note that this also won't work with shell or terminal commands.
 --
 -- Note that multiple instances can still be spawned if the command is called
 -- faster than the client has time to start.
@@ -700,7 +700,7 @@ local raise_rules = {focus = true, switch_to_tags = true, raise = true}
 --
 -- This function depends on the startup notification protocol to be correctly
 -- implemented by the command. See `client.startup_id` for more information.
--- Note that this also wont work with shell or terminal commands.
+-- Note that this also won't work with shell or terminal commands.
 --
 -- @tparam string|table cmd The command.
 -- @tparam table rules The properties that need to be applied to the client.

lib/awful/tag.lua

@@ -266,7 +266,7 @@ end
 --
 -- @constructorfct awful.tag.add
 -- @param name The tag name, a string
--- @param props The tags inital properties, a table
+-- @param props The tags initial properties, a table
 -- @return The created tag
 -- @see tag.delete
 function tag.add(name, props)
@@ -708,7 +708,7 @@ end
 --- The tag master width factor.
 --
 -- The master width factor is one of the 5 main properties used to configure
--- the `layout`. Each layout interpret (or ignore) this property differenly.
+-- the `layout`. Each layout interpret (or ignore) this property differently.
 --
 -- See the layout suit documentation for information about how the master width
 -- factor is used.
@@ -832,7 +832,7 @@ end
 -- The stateful layouts API is the same as stateless, but they are a function
 -- returining a layout instead of a layout itself. They also should have an
 -- `is_dynamic = true` property. If they don't, `awful.tag` will create a new
--- instance everytime the layout is set. If they do, the instance will be
+-- instance every time the layout is set. If they do, the instance will be
 -- cached and re-used.
 --
 --

lib/awful/util.lua

@@ -30,7 +30,7 @@ local gmath = require("gears.math")
 local util = {}
 util.table = {}
 
---- The default shell used when spawing processes.
+--- The default shell used when spawning processes.
 -- @param string
 util.shell = os.getenv("SHELL") or "/bin/sh"
 
@@ -326,7 +326,7 @@ end
 --
 -- Note that this method doesn't copy entries found in `__index`.
 -- @deprecated util.table.crush
--- @tparam table t the table to be overriden
+-- @tparam table t the table to be overridden
 -- @tparam table set the table used to override members of `t`
 -- @tparam[opt=false] boolean raw Use rawset (avoid the metatable)
 -- @treturn table t (for convenience)

lib/awful/wibar.lua

@@ -305,7 +305,7 @@ function awfulwibar.set_position(wb, position, screen)
         gdebug.deprecate("Use `wb.screen = screen` instead of awful.wibar.set_position", {deprecated_in=4})
     end
 
-    -- Detach first to avoid any uneeded callbacks
+    -- Detach first to avoid any unneeded callbacks
     if wb.detach_callback then
         wb.detach_callback()
 
@@ -611,7 +611,7 @@ function awfulwibar.new(args)
 
 
     w.screen   = screen
-    w._screen  = screen --HACK When a screen is removed, then getbycoords wont work
+    w._screen  = screen --HACK When a screen is removed, then getbycoords won't work
     w._stretch = args.stretch == nil and has_to_stretch or args.stretch
 
     if args.visible == nil then w.visible = true end

lib/awful/widget/prompt.lua

@@ -70,7 +70,7 @@ end
 --- Always spawn using a shell.
 --
 -- When using the default `exe_callback`, use `awful.spawn.with_shell` instead
--- of `awful.spawn`. Depending on the ammount of customization to your shell
+-- of `awful.spawn`. Depending on the amount of customization to your shell
 -- environment, this can increase startup time.
 -- @property with_shell
 -- @param[opt=false] boolean

lib/awful/widget/taglist.lua

@@ -23,7 +23,7 @@
 -- `awful.widget.common` also has 2 callbacks to give more control over the widget:
 --
 -- * `create_callback`: Called once after the widget instance is created
--- * `update_callback`: Called everytime the data is refreshed
+-- * `update_callback`: Called every time the data is refreshed
 --
 -- Both callback have the same parameters:
 --
@@ -472,7 +472,7 @@ function taglist.new(args, filter, buttons, style, update_function, base_widget)
     -- Detect the old function signature
     if argstype == "number" or argstype == "screen" or
       (argstype == "table" and args.index and args == capi.screen[args.index]) then
-        gdebug.deprecate("The `screen` paramater is deprecated, use `args.screen`.",
+        gdebug.deprecate("The `screen` parameter is deprecated, use `args.screen`.",
             {deprecated_in=5})
 
         screen = get_screen(args)
@@ -488,7 +488,7 @@ function taglist.new(args, filter, buttons, style, update_function, base_widget)
                         layout          = base_widget
     } do
         gdebug.deprecate("The `awful.widget.taglist()` `"..k
-            .."` paramater is deprecated, use `args."..k.."`.",
+            .."` parameter is deprecated, use `args."..k.."`.",
         {deprecated_in=5})
         args[k] = v
     end

lib/awful/widget/tasklist.lua

@@ -47,7 +47,7 @@
 -- `awful.widget.common` also has 2 callbacks to give more control over the widget:
 --
 -- * `create_callback`: Called once after the widget instance is created
--- * `update_callback`: Called everytime the data is refreshed
+-- * `update_callback`: Called every time the data is refreshed
 --
 -- Both callback have the same parameters:
 --
@@ -58,7 +58,7 @@
 --
 -- It is also possible to omit some roles and create an icon only tasklist.
 -- Notice that this example use the `awful.widget.clienticon` widget instead
--- of an `imagebox`. This allows higher resoluton icons to be loaded. This
+-- of an `imagebox`. This allows higher resolution icons to be loaded. This
 -- example reproduces the Windows 10 tasklist look and feel:
 --
 --@DOC_wibox_awidget_tasklist_windows10_EXAMPLE@
@@ -567,7 +567,7 @@ function tasklist.new(args, filter, buttons, style, update_function, base_widget
     -- Detect the old function signature
     if argstype == "number" or argstype == "screen" or
       (argstype == "table" and args.index and args == capi.screen[args.index]) then
-        gdebug.deprecate("The `screen` paramater is deprecated, use `args.screen`.",
+        gdebug.deprecate("The `screen` parameter is deprecated, use `args.screen`.",
             {deprecated_in=5})
 
         screen = get_screen(args)
@@ -583,7 +583,7 @@ function tasklist.new(args, filter, buttons, style, update_function, base_widget
                         layout          = base_widget
     } do
         gdebug.deprecate("The `awful.widget.tasklist()` `"..k
-            .."` paramater is deprecated, use `args."..k.."`.",
+            .."` parameter is deprecated, use `args."..k.."`.",
         {deprecated_in=5})
         args[k] = v
     end

luaa.c

@@ -653,7 +653,7 @@ static int luaA_get_active_modifiers(lua_State *L)
  *
  * API levels are used to allow newer version of AwesomeWM to alter the behavior
  * and subset deprecated APIs. Using an older API level than the current major
- * version allows to use legacy `rc.lua` with little porting. However, they wont
+ * version allows to use legacy `rc.lua` with little porting. However, they won't
  * be able to use all the new features. Attempting to use a newer feature along
  * with an older API level is not and will not be supported, even if it almost
  * works. Keeping up to date with the newer API levels is highly recommended.
@@ -684,7 +684,7 @@ static int luaA_get_active_modifiers(lua_State *L)
  */
 
 /**
- * Error message for errors that occured during
+ * Error message for errors that occurred during
  *  startup.
  * @tfield string startup_errors
  */

options.c

@@ -331,14 +331,14 @@ options_detect_shebang(int argc, char **argv)
 {
     /* There is no cross-platform ways to check if it is *really* called by a
      * shebang. There is a couple Linux specific hacks which work with the
-     * most common C libraries, but they wont work on *BSD.
+     * most common C libraries, but they won't work on *BSD.
      *
      * On some platforms, the argv is going to be parsed by the OS, in other
      * they will be concatenated in one big string. There is some ambiguities
      * caused by that. For example, `awesome -s foo` and and `#!/bin/awesome -s`
      * are both technically valid if `foo` is a directory in the first and
      * lua file (without extension) in the second. While `-s` with a file
-     * wont work, it is hard to know by looking at the string.
+     * won't work, it is hard to know by looking at the string.
      *
      * The trick to avoid any ambiguity is to just read the file and see if
      * the args match. `options_init_config` will be called later and the args