From 3145e3145e5469ac4efc1eea3d31fa644a4fc26f Mon Sep 17 00:00:00 2001 From: Brian Gianforcaro Date: Sun, 30 Aug 2009 01:26:19 -0400 Subject: [PATCH] Grammar/spelling corrections in comments and docs. Signed-off-by: Brian Gianforcaro Signed-off-by: Julien Danjou --- README | 6 +++--- awesome.c | 8 ++++---- client.c | 14 +++++++------- color.c | 4 ++-- common/atoms.c | 2 +- common/buffer.h | 2 +- common/luaobject.c | 6 +++--- common/luaobject.h | 2 +- common/util.h | 4 ++-- draw.c | 2 +- image.c | 6 +++--- key.c | 2 +- keygrabber.c | 4 ++-- luaa.c | 4 ++-- luaa.h | 4 ++-- mouse.c | 4 ++-- screen.c | 6 +++--- screen.h | 2 +- selection.c | 2 +- systray.c | 4 ++-- titlebar.h | 4 ++-- utils/awsetbg | 2 +- wibox.c | 10 +++++----- widget.c | 4 ++-- widgets/graph.c | 2 +- widgets/progressbar.c | 6 +++--- 26 files changed, 58 insertions(+), 58 deletions(-) diff --git a/README b/README index f28d4887..40243594 100644 --- a/README +++ b/README @@ -10,9 +10,9 @@ After extracting the dist tarball, run: This will create a build directory, run cmake in it and build awesome. -After the building done, you can type this to install: +After building is finished, you can install: - make install # might need root permissions + make install # you might need root permissions Running awesome --------------- @@ -32,7 +32,7 @@ the DISPLAY environment variable is set correctly, e.g.: Configuration ------------- The configuration of awesome is done by creating a $XDG_CONFIG_HOME/awesome/rc.lua file. -An example is provided in the sources. +An example configuration named "awesomerc.lua.in" is provided in the source. Troubleshooting --------------- diff --git a/awesome.c b/awesome.c index 471a3e2a..157880de 100644 --- a/awesome.c +++ b/awesome.c @@ -274,8 +274,8 @@ awesome_restart(void) a_exec(globalconf.argv); } -/** Function to restart aweome on some signals. - * \param w the signam received, unused +/** Function to restart awesome on some signals. + * \param w the signal received, unused * \param revents Currently unused */ static void @@ -289,7 +289,7 @@ restart_on_signal(EV_P_ ev_signal *w, int revents) * ignored (especially on UnmapNotify's). Other types of errors call Xlibs * default error handler, which may call exit. * \param data Currently unused. - * \param c The connectiont to the X server. + * \param c The connection to the X server. * \param e The error event. * \return 0 if no error, or xerror's xlib return status. */ @@ -446,7 +446,7 @@ main(int argc, char **argv) xtest_query = xcb_get_extension_data(globalconf.connection, &xcb_test_id); globalconf.have_xtest = xtest_query->present; - /* initiliaze dbus */ + /* initialize dbus */ a_dbus_init(); /* Grab server */ diff --git a/client.c b/client.c index 44f36c0b..99509580 100644 --- a/client.c +++ b/client.c @@ -305,7 +305,7 @@ client_unfocus(client_t *c) client_unfocus_update(c); } -/** Check if client supports protocol a protocole in WM_PROTOCOL. +/** Check if client supports atom a protocol in WM_PROTOCOL. * \param c The client. * \param atom The protocol atom to check for. * \return True if client has the atom in protocol, false otherwise. @@ -355,7 +355,7 @@ client_ban(client_t *c) } } -/** This is part of The Bob Marley Algorithmm: we ignore enter and leave window +/** This is part of The Bob Marley Algorithm: we ignore enter and leave window * in certain cases, like map/unmap or move, so we don't get spurious events. */ void @@ -688,7 +688,7 @@ client_manage(xcb_window_t w, xcb_get_geometry_reply_t *wgeom, int phys_screen, /* Always stay in NORMAL_STATE. Even though iconified seems more * appropriate sometimes. The only possible loss is that clients not using - * visibility events may continue to proces data (when banned). + * visibility events may continue to process data (when banned). * Without any exposes or other events the cost should be fairly limited though. * * Some clients may expect the window to be unmapped when STATE_ICONIFIED. @@ -830,7 +830,7 @@ client_geometry_hints(client_t *c, area_t geometry) } /** Resize client window. - * The sizse given as parameters are with titlebar and borders! + * The sizes given as parameters are with titlebar and borders! * \param c Client to resize. * \param geometry New window geometry. * \param hints Use size hints. @@ -863,7 +863,7 @@ client_resize(client_t *c, area_t geometry, bool hints) if(geometry_internal.width == 0 || geometry_internal.height == 0) return false; - /* Also let client hints propegate to the "official" geometry. */ + /* Also let client hints propagate to the "official" geometry. */ geometry = titlebar_geometry_add(c->titlebar, c->border_width, geometry_internal); if(c->geometries.internal.x != geometry_internal.x @@ -1229,7 +1229,7 @@ client_unmanage(client_t *c) { tag_array_t *tags = &c->screen->tags; - /* Reset transient_for attributes of widows that maybe refering to us */ + /* Reset transient_for attributes of widows that maybe referring to us */ foreach(_tc, globalconf.clients) { client_t *tc = *_tc; @@ -1317,7 +1317,7 @@ client_kill(client_t *c) * \param L The Lua VM state. * \return The number of elements pushed on stack. * \luastack - * \lparam An optional screen nunmber. + * \lparam An optional screen number. * \lreturn A table with all clients. */ static int diff --git a/color.c b/color.c index 0fb929ca..31d33481 100644 --- a/color.c +++ b/color.c @@ -128,7 +128,7 @@ color_init_unchecked(color_t *color, const char *colstr, ssize_t len) /** Initialize a color. * \param req color_init request. - * \return True if color allocation was successfull. + * \return True if color allocation was successful. */ bool color_init_reply(color_init_cookie_t req) @@ -218,7 +218,7 @@ xcolor_init_unchecked(xcolor_t *color, const char *colstr, ssize_t len) /** Initialize a X color. * \param req xcolor_init request. - * \return True if color allocation was successfull. + * \return True if color allocation was successful. */ bool xcolor_init_reply(xcolor_init_request_t req) diff --git a/common/atoms.c b/common/atoms.c index b3760e7f..fd7f612f 100644 --- a/common/atoms.c +++ b/common/atoms.c @@ -49,7 +49,7 @@ atoms_init(xcb_connection_t *conn) for(i = 0; i < countof(ATOM_LIST); i++) { if(!(r = xcb_intern_atom_reply(conn, cs[i], NULL))) - /* An error occured, get reply for next atom */ + /* An error occurred, get reply for next atom */ continue; *ATOM_LIST[i].atom = r->atom; diff --git a/common/buffer.h b/common/buffer.h index 403d655f..c55782fc 100644 --- a/common/buffer.h +++ b/common/buffer.h @@ -83,7 +83,7 @@ buffer_wipe(buffer_t *buf) } /** Get a new buffer. - * \return A new allocatedbuffer. + * \return A new allocated buffer. */ static inline buffer_t * buffer_new(void) diff --git a/common/luaobject.c b/common/luaobject.c index 10a95979..66bfe950 100644 --- a/common/luaobject.c +++ b/common/luaobject.c @@ -52,7 +52,7 @@ luaA_object_incref(lua_State *L, int tud, int oud) /* Get pointer value of the item */ void *pointer = (void *) lua_topointer(L, oud); - /* Not referencable. */ + /* Not reference able. */ if(!pointer) { lua_remove(L, oud); @@ -152,7 +152,7 @@ luaA_settype(lua_State *L, lua_class_t *lua_class) * \param L The Lua VM state. * \param oud The object index on the stack. * \param name The name of the signal. - * \param ud The index of function to call when signal is emited. + * \param ud The index of function to call when signal is emitted. */ void luaA_object_add_signal(lua_State *L, int oud, @@ -167,7 +167,7 @@ luaA_object_add_signal(lua_State *L, int oud, * \param L The Lua VM state. * \param oud The object index on the stack. * \param name The name of the signal. - * \param ud The index of function to call when signal is emited. + * \param ud The index of function to call when signal is emitted. */ void luaA_object_remove_signal(lua_State *L, int oud, diff --git a/common/luaobject.h b/common/luaobject.h index d0c6801c..19aca17f 100644 --- a/common/luaobject.h +++ b/common/luaobject.h @@ -95,7 +95,7 @@ luaA_object_registry_push(lua_State *L) * That only works with userdata, table, thread or function. * \param L The Lua VM state. * \param oud The object index on the stack. - * \return The object reference, or NULL if not referencable. + * \return The object reference, or NULL if not referenceable. */ static inline void * luaA_object_ref(lua_State *L, int oud) diff --git a/common/util.h b/common/util.h index 019cc953..4c536329 100644 --- a/common/util.h +++ b/common/util.h @@ -52,7 +52,7 @@ typedef enum Left } position_t; -/** \brief replace \c NULL strings with emtpy strings */ +/** \brief replace \c NULL strings with empty strings */ #define NONULL(x) (x ? x : "") #define DO_NOTHING(...) @@ -200,7 +200,7 @@ static inline ssize_t a_strnlen(const char *s, ssize_t n) /** \brief \c NULL resistant strdup. * - * the a_strdup() function returns a pointer to a new string, which is a + * The a_strdup() function returns a pointer to a new string, which is a * duplicate of \c s. Memory should be freed using p_delete(). * * \warning when s is \c "", it returns NULL ! diff --git a/draw.c b/draw.c index e94215b2..7bcb0ab2 100644 --- a/draw.c +++ b/draw.c @@ -668,7 +668,7 @@ draw_text_extents(draw_text_context_t *data) /** Transform a string to a alignment_t type. * Recognized string are flex, fixed, left, center, middle or right. - * \param align Atring with align text. + * \param align A string with align text. * \param len The string length. * \return An alignment_t type. */ diff --git a/image.c b/image.c index a472133d..76ad084e 100644 --- a/image.c +++ b/image.c @@ -67,11 +67,11 @@ image_imlib_load_strerror(Imlib_Load_Error e) case IMLIB_LOAD_ERROR_PATH_TOO_LONG: return "path too long"; case IMLIB_LOAD_ERROR_PATH_COMPONENT_NON_EXISTANT: - return "path component non existant"; + return "path component non existent"; case IMLIB_LOAD_ERROR_PATH_COMPONENT_NOT_DIRECTORY: - return "path compoment not a directory"; + return "path component not a directory"; case IMLIB_LOAD_ERROR_PATH_POINTS_OUTSIDE_ADDRESS_SPACE: - return "path points oustide address space"; + return "path points outside address space"; case IMLIB_LOAD_ERROR_TOO_MANY_SYMBOLIC_LINKS: return "too many symbolic links"; case IMLIB_LOAD_ERROR_OUT_OF_MEMORY: diff --git a/key.c b/key.c index 624a33a3..cc8587b0 100644 --- a/key.c +++ b/key.c @@ -957,7 +957,7 @@ key_getkeysym(xcb_keycode_t detail, uint16_t state) * instead */ return k1; - /* The Shift modifer is on, or the Lock modifier is on and is + /* The Shift modifier is on, or the Lock modifier is on and is * interpreted as ShiftLock, or both */ else if((state & XCB_MOD_MASK_SHIFT) || (state & XCB_MOD_MASK_LOCK && (state & globalconf.shiftlockmask))) diff --git a/keygrabber.c b/keygrabber.c index e9d409e8..88cfd981 100644 --- a/keygrabber.c +++ b/keygrabber.c @@ -57,7 +57,7 @@ keygrabber_grab(void) /** Handle keypress event. * \param L Lua stack to push the key pressed. * \param e Received XKeyEvent. - * \return True if a key was succesfully get, false otherwise. + * \return True if a key was successfully get, false otherwise. */ bool keygrabber_handlekpress(lua_State *L, xcb_key_press_event_t *e) @@ -92,7 +92,7 @@ keygrabber_handlekpress(lua_State *L, xcb_key_press_event_t *e) * continue grabbing, false to stop. * The function is called with 3 arguments: * a table containing modifiers keys, a string with the key pressed and a - * string with eithe "press" or "release" to indicate the event type. + * string with either "press" or "release" to indicate the event type. * * \param L The Lua VM state. * \return The number of elements pushed on stack. diff --git a/luaa.c b/luaa.c index d508e8b0..f278cdab 100644 --- a/luaa.c +++ b/luaa.c @@ -237,7 +237,7 @@ luaAe_type(lua_State *L) } /** Modified version of os.execute() which use spawn code to reset signal - * handlers correctly before exec()ing the new program. + * handlers correctly before exec()'ing the new program. * \param L The Lua VM state. * \return The number of arguments pushed on stack. */ @@ -342,7 +342,7 @@ luaA_wtable_index(lua_State *L) return 1; } -/** Newndex function of wtable objects. +/** Newindex function of wtable objects. * \param L The Lua VM state. * \return The number of elements pushed on stack. */ diff --git a/luaa.h b/luaa.h index e56d3fe7..4ed896f5 100644 --- a/luaa.h +++ b/luaa.h @@ -112,7 +112,7 @@ luaA_pusharea(lua_State *L, area_t geometry) * \param L The Lua stack. * \param idx Index of the object in the stack. * \param ref A int address: it will be filled with the int - * registered. If the adresse point to an already registered object, it will + * registered. If the address points to an already registered object, it will * be unregistered. * \return Always 0. */ @@ -141,7 +141,7 @@ luaA_unregister(lua_State *L, int *ref) * \param L The Lua stack. * \param idx Index of the function in the stack. * \param fct A int address: it will be filled with the int - * registered. If the adresse point to an already registered function, it will + * registered. If the address points to an already registered function, it will * be unregistered. * \return luaA_register value. */ diff --git a/mouse.c b/mouse.c index 24acf569..98f4772f 100644 --- a/mouse.c +++ b/mouse.c @@ -34,7 +34,7 @@ * \param y will be set to the Pointer-y-coordinate relative to window * \param child Will be set to the window under the pointer. * \param mask will be set to the current buttons state - * \return true on success, false if an error occured + * \return true on success, false if an error occurred **/ bool mouse_query_pointer(xcb_window_t window, int16_t *x, int16_t *y, xcb_window_t *child, uint16_t *mask) @@ -66,7 +66,7 @@ mouse_query_pointer(xcb_window_t window, int16_t *x, int16_t *y, xcb_window_t *c * \param y This will be set to the Pointer-y-coordinate relative to window. * \param child This will be set to the window under the pointer. * \param mask This will be set to the current buttons state. - * \return True on success, false if an error occured. + * \return True on success, false if an error occurred. */ static bool mouse_query_pointer_root(screen_t **s, int16_t *x, int16_t *y, xcb_window_t *child, uint16_t *mask) diff --git a/screen.c b/screen.c index 5a2c8e53..82182856 100644 --- a/screen.c +++ b/screen.c @@ -255,7 +255,7 @@ screen_virttophys(int screen) /** Move a client to a virtual screen. * \param c The client to move. - * \param new_screen The destinatiuon screen. + * \param new_screen The destination screen. * \param doresize Set to true if we also move the client to the new x and * y of the new screen. */ @@ -340,7 +340,7 @@ screen_client_moveto(client_t *c, screen_t *new_screen, bool doresize) /** Push a screen onto the stack. * \param L The Lua VM state. - * \param s The scren to push. + * \param s The screen to push. * \return The number of elements pushed on stack. */ int @@ -455,7 +455,7 @@ luaA_screen_index(lua_State *L) * \luastack * \lvalue A screen. * \lparam A signal name. - * \lparam A function to call when the signal is emited. + * \lparam A function to call when the signal is emitted. */ static int luaA_screen_add_signal(lua_State *L) diff --git a/screen.h b/screen.h index 2172ac75..019e2a69 100644 --- a/screen.h +++ b/screen.h @@ -47,7 +47,7 @@ struct a_screen SnMonitorContext *snmonitor; /** The default visual, used to draw */ xcb_visualtype_t *visual; - /** The signals emited by screen objects */ + /** The signals emitted by screen objects */ signal_array_t signals; }; ARRAY_FUNCS(screen_t, screen, DO_NOTHING) diff --git a/selection.c b/selection.c index 23596ec5..a4433642 100644 --- a/selection.c +++ b/selection.c @@ -71,7 +71,7 @@ luaA_selection_get(lua_State *L) * xcb_event_poll_for_event_loop() and awesome_refresh(), * then check if some static buffer has been filled with data. * If yes, that'd be the xsel data, otherwise, re-loop. - * Anyway that's still brokes the socket or D-Bus, so maybe using + * Anyway that's still brakes the socket or D-Bus, so maybe using * ev_loop() would be even better. */ xcb_event_handle(&globalconf.evenths, event); diff --git a/systray.c b/systray.c index b2863821..1f573eef 100644 --- a/systray.c +++ b/systray.c @@ -127,7 +127,7 @@ systray_cleanup(int phys_screen) /** Handle a systray request. * \param embed_win The window to embed. * \param phys_screen The physical monitor to display on. - * \param info The embeding info + * \param info The embedding info * \return 0 on no error. */ int @@ -221,7 +221,7 @@ systray_iskdedockapp(xcb_window_t w) xcb_get_property_reply_t *kde_check; bool ret; - /* Check if that is a KDE tray because it does not repect fdo standards, + /* Check if that is a KDE tray because it does not respect fdo standards, * thanks KDE. */ kde_check_q = xcb_get_property_unchecked(globalconf.connection, false, w, _KDE_NET_WM_SYSTEM_TRAY_WINDOW_FOR, diff --git a/titlebar.h b/titlebar.h index 3d084c34..42d0af66 100644 --- a/titlebar.h +++ b/titlebar.h @@ -62,7 +62,7 @@ static inline area_t titlebar_geometry_add(wibox_t *t, int border, area_t geometry) { /* We need to add titlebar border to the total width and height. - * This can then be substracted/added to the witdh/height/x/y. + * This can then be subtracted/added to the width/height/x/y. * In this case the border is included, because it belongs to a different window. */ if(t && t->visible) @@ -103,7 +103,7 @@ static inline area_t titlebar_geometry_remove(wibox_t *t, int border, area_t geometry) { /* We need to add titlebar border to the total width and height. - * This can then be substracted/added to the witdh/height/x/y. + * This can then be subtracted/added to the width/height/x/y. * In this case the border is included, because it belongs to a different window. */ if(t && t->visible) diff --git a/utils/awsetbg b/utils/awsetbg index f2f1b1e6..f5e7dcea 100755 --- a/utils/awsetbg +++ b/utils/awsetbg @@ -89,7 +89,7 @@ Options: -u Use specified wallpapersetter, use no argument to forget. -r set random wallpaper from a directory - -F,-C,-T,-A,-U,-R same as uncapsed but without remembering. + -F,-C,-T,-A,-U,-R same as lowercase but without remembering. -h Display this help. diff --git a/wibox.c b/wibox.c index be148989..a6e96100 100644 --- a/wibox.c +++ b/wibox.c @@ -94,7 +94,7 @@ shape_update(xcb_window_t win, xcb_shape_kind_t kind, image_t *image, int offset } /** Update the window's shape. - * \param wibox The simplw window whose shape should be updated. + * \param wibox The simple window whose shape should be updated. */ static void wibox_shape_update(wibox_t *wibox) @@ -258,13 +258,13 @@ wibox_moveresize(lua_State *L, int udx, area_t geometry) wibox_draw_context_update(w, s); } - /* Activatate BMA */ + /* Activate BMA */ client_ignore_enterleave_events(); if(mask_vals) xcb_configure_window(globalconf.connection, w->window, mask_vals, moveresize_win_vals); - /* Deactivatate BMA */ + /* Deactivate BMA */ client_restore_enterleave_events(); w->screen = screen_getbycoord(w->screen, w->geometry.x, w->geometry.y); @@ -369,7 +369,7 @@ wibox_map(wibox_t *wibox) client_ignore_enterleave_events(); /* Map the wibox */ xcb_map_window(globalconf.connection, wibox->window); - /* Deactivatate BMA */ + /* Deactivate BMA */ client_restore_enterleave_events(); /* We must make sure the wibox does not display garbage */ wibox_need_update(wibox); @@ -784,7 +784,7 @@ wibox_attach(lua_State *L, int udx, screen_t *s) * \param L The Lua VM state. * * \luastack - * \lparam A table with optionaly defined values: + * \lparam A table with optionally defined values: * fg, bg, border_width, border_color, ontop, width and height. * \lreturn A brand new wibox. */ diff --git a/widget.c b/widget.c index aecb3f26..0698e57d 100644 --- a/widget.c +++ b/widget.c @@ -98,7 +98,7 @@ widget_getbycoords(orientation_t orientation, widget_node_array_t *widgets, return NULL; } -/** Convert a Lua table to a list of widget nodet. +/** Convert a Lua table to a list of widget nodes. * \param L The Lua VM state. * \param widgets The linked list of widget node. */ @@ -534,7 +534,7 @@ luaA_widget_set_type(lua_State *L, widget_t *w) } if(!wc) - luaL_error(L, "unkown widget type: %s", type); + luaL_error(L, "unknown widget type: %s", type); wc(w); w->type = wc; diff --git a/widgets/graph.c b/widgets/graph.c index 9ece773d..2dbe6a3e 100644 --- a/widgets/graph.c +++ b/widgets/graph.c @@ -36,7 +36,7 @@ typedef enum /** The plot data structure. */ typedef struct { - /** Grapht title of the plot sections */ + /** Graph title of the plot sections */ char *title; /** Represents a full graph */ float max_value; diff --git a/widgets/progressbar.c b/widgets/progressbar.c index 989b8f52..12bae0a9 100644 --- a/widgets/progressbar.c +++ b/widgets/progressbar.c @@ -195,7 +195,7 @@ progressbar_draw(widget_t *widget, draw_context_t *ctx, area_t geometry, wibox_t * basic progressbar: * 1. the full space gets the size of the formerly empty one * 2. the pattern must be mirrored - * 3. the formerly 'empty' side gets drawed with fg colors, the 'full' with bg-color + * 3. the formerly 'empty' side is drawn with fg colors, the 'full' with bg-color * * ticks: * 1. round the values to a full tick accordingly @@ -307,7 +307,7 @@ progressbar_draw(widget_t *widget, draw_context_t *ctx, area_t geometry, wibox_t else draw_rectangle(ctx, rectangle, 1.0, true, &bar->fg_off); } - /* draw gaps TODO: improve e.g all in one */ + /* draw gaps \todo improve e.g all in one */ if(d->ticks_count && d->ticks_gap) { rectangle.width = pb_width; @@ -415,7 +415,7 @@ progressbar_draw(widget_t *widget, draw_context_t *ctx, area_t geometry, wibox_t else draw_rectangle(ctx, rectangle, 1.0, true, &bar->fg_off); } - /* draw gaps TODO: improve e.g all in one */ + /* draw gaps \todo improve e.g all in one */ if(d->ticks_count && d->ticks_gap) { rectangle.width = d->ticks_gap;