Merge branch 'spelling' of https://github.com/jsoref/rabbitmq-server into jsoref-spelling

Author: michaelklishin

docs/rabbitmq-service.8

@@ -115,7 +115,7 @@ Defaults to
 for 64-bit environments).
 This is the installation location of the Erlang service manager.
 .It Ev RABBITMQ_CONSOLE_LOG
-Set this varable to
+Set this variable to
 .Sy new or
 .Sy reuse
 to have the console output from the server redirected to a file named

docs/rabbitmq.conf.example

@@ -804,7 +804,7 @@
 ## See http://rabbitmq.com/logging.html and https://github.com/erlang-lager/lager for details.
 ##
 
-## Log direcrory, taken from the RABBITMQ_LOG_BASE env variable by default.
+## Log directory, taken from the RABBITMQ_LOG_BASE env variable by default.
 ##
 # log.dir = /var/log/rabbitmq
 

docs/rabbitmq.config.example

@@ -339,7 +339,7 @@
 
    %% Enables flow control between queue mirrors.
    %% Disabling this can be dangerous and is not recommended.
-   %% When flow control is disablied, queue masters can outpace mirrors and not allow mirrors to catch up.
+   %% When flow control is disabled, queue masters can outpace mirrors and not allow mirrors to catch up.
    %% Mirrors will end up using increasingly more RAM, eventually triggering a memory alarm.
    %%
    %% {mirroring_flow_control, true},
@@ -909,7 +909,7 @@
    %%   {rabbit_channel_lager_event, [{handlers, [
    %%                                   {lager_forwarder_backend,
    %%                                    [lager_event, info]}]}]},
-   %%   {rabbit_conection_lager_event, [{handlers, [
+   %%   {rabbit_connection_lager_event, [{handlers, [
    %%                                     {lager_forwarder_backend,
    %%                                      [lager_event, info]}]}]},
    %%   {rabbit_mirroring_lager_event, [{handlers, [

docs/rabbitmqctl.8

@@ -156,7 +156,7 @@ To use this precompiled files, you should set
 .Ev RABBITMQ_SERVER_CODE_PATH
 environment variable to directory specified in
 .Cm hipe_compile
-invokation.
+invocation.
 .Pp
 For example, to HiPE-compile modules and store them to
 .Pa /tmp/rabbit-hipe/ebin
@@ -255,7 +255,7 @@ For example, to instruct the RabbitMQ node to terminate:
 .Dl rabbitmqctl stop
 .\" ------------------------------------
 .It Cm stop_app
-Stops the RabbitMQ application, leaving the runtme (Erlang VM) running.
+Stops the RabbitMQ application, leaving the runtime (Erlang VM) running.
 .Pp
 This command is typically run prior to performing other management
 actions that require the RabbitMQ application to be stopped, e.g.\&

erlang.mk

@@ -596,7 +596,7 @@ pkg_check_node_commit = master
 
 PACKAGES += chronos
 pkg_chronos_name = chronos
-pkg_chronos_description = Timer module for Erlang that makes it easy to abstact time out of the tests.
+pkg_chronos_description = Timer module for Erlang that makes it easy to abstract time out of the tests.
 pkg_chronos_homepage = https://github.com/lehoff/chronos
 pkg_chronos_fetch = git
 pkg_chronos_repo = https://github.com/lehoff/chronos
@@ -1340,7 +1340,7 @@ pkg_erlang_cep_commit = master
 
 PACKAGES += erlang_js
 pkg_erlang_js_name = erlang_js
-pkg_erlang_js_description = A linked-in driver for Erlang to Mozilla's Spidermonkey Javascript runtime.
+pkg_erlang_js_description = A linked-in driver for Erlang to Mozilla's Spidermonkey JavaScript runtime.
 pkg_erlang_js_homepage = https://github.com/basho/erlang_js
 pkg_erlang_js_fetch = git
 pkg_erlang_js_repo = https://github.com/basho/erlang_js
@@ -4132,7 +4132,7 @@ pkg_yaws_commit = master
 
 PACKAGES += zab_engine
 pkg_zab_engine_name = zab_engine
-pkg_zab_engine_description = zab propotocol implement by erlang
+pkg_zab_engine_description = zab protocol implement by erlang
 pkg_zab_engine_homepage = https://github.com/xinmingyao/zab_engine
 pkg_zab_engine_fetch = git
 pkg_zab_engine_repo = https://github.com/xinmingyao/zab_engine

priv/schema/rabbit.schema

@@ -903,7 +903,7 @@ fun(Conf) ->
     end
 end}.
 
-%% Classic config-driven peer discuvery backend.
+%% Classic config-driven peer discovery backend.
 %%
 %% Make clustering happen *automatically* at startup - only applied
 %% to nodes that have just been reset or started for the first time.
@@ -1530,7 +1530,7 @@ fun(Size) when is_integer(Size) ->
     Size > 0 andalso Size < 536870912
 end}.
 
-{validator, "less_than_1", "Flooat is not beetween 0 and 1",
+{validator, "less_than_1", "Float is not between 0 and 1",
 fun(Float) when is_float(Float) ->
     Float > 0 andalso Float < 1
 end}.

rabbitmq-components.mk

@@ -226,7 +226,7 @@ export base_rmq_ref
 # If cloning from this computed location fails, we fallback to RabbitMQ
 # upstream which is GitHub.
 
-# Maccro to transform eg. "rabbit_common" to "rabbitmq-common".
+# Macro to transform eg. "rabbit_common" to "rabbitmq-common".
 rmq_cmp_repo_name = $(word 2,$(dep_$(1)))
 
 # Upstream URL for the current project.

scripts/rabbitmq-server

@@ -219,7 +219,7 @@ fi
 # The defaults are meant to reduce RabbitMQ's memory usage and help
 # it reclaim memory at the cost of a slight decrease in performance
 # (due to an increase in memory operations). These defaults can be
-# overriden using the RABBITMQ_SERVER_ERL_ARGS variable.
+# overridden using the RABBITMQ_SERVER_ERL_ARGS variable.
 RABBITMQ_DEFAULT_ALLOC_ARGS="+MBas ageffcbf +MHas ageffcbf +MBlmbcs 512 +MHlmbcs 512 +MMmcs 30"
 
 ${ERL_DIR}erl ${RABBITMQ_DEFAULT_ALLOC_ARGS} \
@@ -374,7 +374,7 @@ else
     #     This is considered an abnormal process termination. Normally, we
     #     don't need to specify this exit code because the shell propagates it.
     #     Unfortunately, the signal handler doesn't work as expected in Dash,
-    #     thus we need to explicitely restate the exit code.
+    #     thus we need to explicitly restate the exit code.
     trap "stop_rabbitmq_server; exit 0" HUP TERM TSTP
     trap "stop_rabbitmq_server; exit 130" INT
 

scripts/rabbitmq-server.bat

@@ -167,7 +167,7 @@ rem
 rem The defaults are meant to reduce RabbitMQ's memory usage and help
 rem it reclaim memory at the cost of a slight decrease in performance
 rem (due to an increase in memory operations). These defaults can be
-rem overriden using the RABBITMQ_SERVER_ERL_ARGS variable.
+rem overridden using the RABBITMQ_SERVER_ERL_ARGS variable.
 
 set RABBITMQ_DEFAULT_ALLOC_ARGS=+MBas ageffcbf +MHas ageffcbf +MBlmbcs 512 +MHlmbcs 512 +MMmcs 30
 

scripts/rabbitmq-service.bat

@@ -254,7 +254,7 @@ rem
 rem The defaults are meant to reduce RabbitMQ's memory usage and help
 rem it reclaim memory at the cost of a slight decrease in performance
 rem (due to an increase in memory operations). These defaults can be
-rem overriden using the RABBITMQ_SERVER_ERL_ARGS variable.
+rem overridden using the RABBITMQ_SERVER_ERL_ARGS variable.
 
 set RABBITMQ_DEFAULT_ALLOC_ARGS=+MBas ageffcbf +MHas ageffcbf +MBlmbcs 512 +MHlmbcs 512 +MMmcs 30
 

src/gm.erl

@@ -1271,7 +1271,7 @@ neighbour_cast(N, Msg) -> ?INSTR_MOD:cast(get_pid(N), Msg).
 neighbour_call(N, Msg) -> ?INSTR_MOD:call(get_pid(N), Msg, infinity).
 
 %% ---------------------------------------------------------------------------
-%% View monitoring and maintanence
+%% View monitoring and maintenance
 %% ---------------------------------------------------------------------------
 
 ensure_neighbour(_Ver, Self, {Self, undefined}, Self) ->

src/rabbit_amqqueue_process.erl

@@ -1195,7 +1195,7 @@ prioritise_cast(Msg, _Len, State) ->
 %% will be rate limited by how fast consumers receive messages -
 %% i.e. by notify_sent. We prioritise ack and resume to discourage
 %% starvation caused by prioritising notify_sent. We don't vary their
-%% prioritiy since acks should stay in order (some parts of the queue
+%% priority since acks should stay in order (some parts of the queue
 %% stack are optimised for that) and to make things easier to reason
 %% about. Finally, we prioritise ack over resume since it should
 %% always reduce memory use.

src/rabbit_backing_queue.erl

@@ -158,7 +158,7 @@
 
 %% Drop messages from the head of the queue while the supplied
 %% predicate on message properties returns true. Returns the first
-%% message properties for which the predictate returned false, or
+%% message properties for which the predicate returned false, or
 %% 'undefined' if the whole backing queue was traversed w/o the
 %% predicate ever returning false.
 -callback dropwhile(msg_pred(), state())

src/rabbit_channel.erl

@@ -1455,7 +1455,7 @@ handle_method(#'basic.qos'{prefetch_size = Size}, _, _State) when Size /= 0 ->
 handle_method(#'basic.qos'{global         = false,
                            prefetch_count = PrefetchCount},
               _, State = #ch{limiter = Limiter}) ->
-    %% Ensures that if default was set, it's overriden
+    %% Ensures that if default was set, it's overridden
     Limiter1 = rabbit_limiter:unlimit_prefetch(Limiter),
     {reply, #'basic.qos_ok'{}, State#ch{consumer_prefetch = PrefetchCount,
                                         limiter = Limiter1}};

src/rabbit_feature_flags.erl

@@ -1411,7 +1411,7 @@ does_node_support(Node, FeatureNames, Timeout) ->
             %% If rabbit_feature_flags:is_supported_locally/1 is undefined
             %% on the remote node, we consider it to be a 3.7.x node.
             %%
-            %% Theoritically, it could be an older version (3.6.x and
+            %% Theoretically, it could be an older version (3.6.x and
             %% older). But the RabbitMQ version consistency check
             %% (rabbit_misc:version_minor_equivalent/2) called from
             %% rabbit_mnesia:check_rabbit_consistency/2 already blocked

src/rabbit_ff_registry.erl

@@ -148,7 +148,7 @@ is_registry_written_to_disk() ->
 always_return_true() ->
     %% This function is here to trick Dialyzer. We want some functions
     %% in this initial on-disk registry to always return `true` or
-    %% `false`. However the generated regsitry will return actual
+    %% `false`. However the generated registry will return actual
     %% booleans. The `-spec()` correctly advertises a return type of
     %% `boolean()`. But in the meantime, Dialyzer only knows about this
     %% copy which, without the trick below, would always return either

src/rabbit_fifo.erl

@@ -156,7 +156,7 @@
     #update_config{}.
 
 -type command() :: protocol() | ra_machine:builtin_command().
-%% all the command types suppored by ra fifo
+%% all the command types supported by ra fifo
 
 -type client_msg() :: delivery().
 %% the messages `rabbit_fifo' can send to consumers.
@@ -323,7 +323,7 @@ apply(Meta,
     case Cons0 of
         #{ConsumerId := Con0} ->
             % need to increment metrics before completing as any snapshot
-            % states taken need to includ them
+            % states taken need to include them
             complete_and_checkout(Meta, MsgIds, ConsumerId,
                                   Con0, [], State);
         _ ->
@@ -693,7 +693,7 @@ get_checked_out(Cid, From, To, #state{consumers = Consumers}) ->
     end.
 
 init_aux(Name) when is_atom(Name) ->
-    %% TODO: catch specific exeption throw if table already exists
+    %% TODO: catch specific exception throw if table already exists
     ok = ra_machine_ets:create_table(rabbit_fifo_usage,
                                      [named_table, set, public,
                                       {write_concurrency, true}]),
@@ -1108,7 +1108,7 @@ increase_credit(#consumer{lifetime = once,
 increase_credit(#consumer{lifetime = auto,
                           credit_mode = credited,
                           credit = Credit}, _) ->
-    %% credit_mode: credit also doens't automatically increment credit
+    %% credit_mode: credit also doesn't automatically increment credit
     Credit;
 increase_credit(#consumer{credit = Current}, Credit) ->
     Current + Credit.
@@ -2139,7 +2139,7 @@ enq_check_settle_duplicate_test() ->
     run_snapshot_test(?FUNCTION_NAME, Commands).
 
 run_snapshot_test(Name, Commands) ->
-    %% create every incremental permuation of the commands lists
+    %% create every incremental permutation of the commands lists
     %% and run the snapshot tests against that
     [begin
          run_snapshot_test0(Name, C)
@@ -2208,7 +2208,7 @@ state_enter_test() ->
     [{mod_call, m, f, [a, the_name]}] = state_enter(leader, S0),
     ok.
 
-state_enter_montors_and_notifications_test() ->
+state_enter_monitors_and_notifications_test() ->
     Oth = spawn(fun () -> ok end),
     {State0, _} = enq(1, 1, first, test_init(test)),
     Cid = {<<"adf">>, self()},

src/rabbit_fifo_client.erl

@@ -165,7 +165,7 @@ enqueue(Msg, State) ->
 
 %% @doc Dequeue a message from the queue.
 %%
-%% This is a syncronous call. I.e. the call will block until the command
+%% This is a synchronous call. I.e. the call will block until the command
 %% has been accepted by the ra process or it times out.
 %%
 %% @param ConsumerTag a unique tag to identify this particular consumer.
@@ -297,7 +297,7 @@ discard(ConsumerTag, [_|_] = MsgIds,
 %% @doc Register with the rabbit_fifo queue to "checkout" messages as they
 %% become available.
 %%
-%% This is a syncronous call. I.e. the call will block until the command
+%% This is a synchronous call. I.e. the call will block until the command
 %% has been accepted by the ra process or it times out.
 %%
 %% @param ConsumerTag a unique tag to identify this particular consumer.
@@ -316,7 +316,7 @@ checkout(ConsumerTag, NumUnsettled, ConsumerInfo, State0) ->
 %% @doc Register with the rabbit_fifo queue to "checkout" messages as they
 %% become available.
 %%
-%% This is a syncronous call. I.e. the call will block until the command
+%% This is a synchronous call. I.e. the call will block until the command
 %% has been accepted by the ra process or it times out.
 %%
 %% @param ConsumerTag a unique tag to identify this particular consumer.
@@ -374,7 +374,7 @@ credit(ConsumerTag, Credit, Drain,
 
 %% @doc Cancels a checkout with the rabbit_fifo queue  for the consumer tag
 %%
-%% This is a syncronous call. I.e. the call will block until the command
+%% This is a synchronous call. I.e. the call will block until the command
 %% has been accepted by the ra process or it times out.
 %%
 %% @param ConsumerTag a unique tag to identify this particular consumer.

src/rabbit_fifo_index.erl

@@ -87,7 +87,7 @@ find_next(Next, Last, Map) ->
         _ ->
             % in degenerate cases the range here could be very large
             % and hence this could be very slow
-            % the typical case should idealy be better
+            % the typical case should ideally be better
             % assuming fifo-ish deletion of entries
             find_next(Next+1, Last, Map)
     end.

src/rabbit_guid.erl

@@ -92,7 +92,7 @@ advance_blocks({B1, B2, B3, B4}, I) ->
     %% hashing {B5, I}. The new hash is used as last block, and the
     %% other three blocks are XORed with it.
     %%
-    %% Doing this is convenient because it avoids cascading conflits,
+    %% Doing this is convenient because it avoids cascading conflicts,
     %% while being very fast. The conflicts are avoided by propagating
     %% the changes through all the blocks at each round by XORing, so
     %% the only occasion in which a collision will take place is when

src/rabbit_lager.erl

@@ -396,7 +396,7 @@ prepare_rabbit_log_config() ->
             set_env_default_log_console();
         FileName when is_list(FileName) ->
             case os:getenv("RABBITMQ_LOGS_source") of
-                %% The user explicitely sets $RABBITMQ_LOGS;
+                %% The user explicitly sets $RABBITMQ_LOGS;
                 %% we should override a file location even
                 %% if it's set in rabbitmq.config
                 "environment" -> set_env_default_log_file(FileName, override);
@@ -406,7 +406,7 @@ prepare_rabbit_log_config() ->
 
     %% Upgrade log file never overrides the value set in rabbitmq.config
     case UpgradeFile of
-        %% No special env for upgrade logs - rederect to the default sink
+        %% No special env for upgrade logs - redirect to the default sink
         undefined -> ok;
         %% Redirect logs to default output.
         DefaultFile -> ok;

src/rabbit_mirror_queue_coordinator.erl

@@ -364,7 +364,7 @@ handle_cast({gm_deaths, DeadGMPids}, State = #state{q = Q}) when ?amqqueue_pid_r
             %% Different slave is now master, stop current coordinator normally.
             %% Initiating queue is now slave and the least we could do is report
             %% deaths which we 'think' we saw.
-            %% NOTE: Reported deaths here, could be inconsistant.
+            %% NOTE: Reported deaths here, could be inconsistent.
             rabbit_mirror_queue_misc:report_deaths(MPid, false, QueueName,
                                                    DeadPids),
             {stop, shutdown, State};

src/rabbit_mirror_queue_misc.erl

@@ -615,7 +615,7 @@ validate_sync_batch_size(none) ->
 validate_sync_batch_size(N) when is_integer(N) andalso N > 0 ->
     ok;
 validate_sync_batch_size(N) ->
-    {error, "ha-sync-batch-size takes an integer greather than 0, "
+    {error, "ha-sync-batch-size takes an integer greater than 0, "
      "~p given", [N]}.
 
 validate_pos(PromoteOnShutdown) ->

src/rabbit_msg_store.erl

@@ -236,7 +236,7 @@
 %% updated.
 %%
 %% On non-clean startup, we scan the files we discover, dealing with
-%% the possibilites of a crash having occurred during a compaction
+%% the possibilities of a crash having occurred during a compaction
 %% (this consists of tidyup - the compaction is deliberately designed
 %% such that data is duplicated on disk rather than risking it being
 %% lost), and rebuild the file summary and index ETS table.
@@ -596,7 +596,7 @@ client_read2(false, undefined, _MsgLocation, Defer, _CState) ->
     Defer();
 client_read2(true, _Right, _MsgLocation, Defer, _CState) ->
     %% Of course, in the mean time, the GC could have run and our msg
-    %% is actually in a different file, unlocked. However, defering is
+    %% is actually in a different file, unlocked. However, deferring is
     %% the safest and simplest thing to do.
     Defer();
 client_read2(false, _Right,

src/rabbit_node_monitor.erl

@@ -219,7 +219,7 @@ subscribe(Pid) ->
 %% We could confirm something by having an HA queue see the pausing
 %% state (and fail over into it) before the node monitor stops us, or
 %% by using unmirrored queues and just having them vanish (and
-%% confiming messages as thrown away).
+%% confirming messages as thrown away).
 %%
 %% So we have channels call in here before issuing confirms, to do a
 %% lightweight check that we have not entered a pausing state.

src/rabbit_priority_queue.erl

@@ -22,7 +22,7 @@
 
 -behaviour(rabbit_backing_queue).
 
-%% enabled unconditionally. Disabling priority queueing after
+%% enabled unconditionally. Disabling priority queuing after
 %% it has been enabled is dangerous.
 -rabbit_boot_step({?MODULE,
                    [{description, "enable priority queue"},
@@ -55,7 +55,7 @@
 -define(passthrough3(F),
         {Res1, Res2, BQS1} = BQ:F, {Res1, Res2, State#passthrough{bqs = BQS1}}).
 
-%% This module adds suport for priority queues.
+%% This module adds support for priority queues.
 %%
 %% Priority queues have one backing queue per priority. Backing queue functions
 %% then produce a list of results for each BQ and fold over them, sorting

src/rabbit_queue_index.erl

@@ -355,7 +355,7 @@ pre_publish(MsgOrId, SeqId, MsgProps, IsPersistent, IsDelivered, JournalSizeHint
                      State1#qistate{pre_publish_cache = PPC1,
                                     delivered_cache   = DC1})).
 
-%% pre_publish_cache is the entry with most elements when comapred to
+%% pre_publish_cache is the entry with most elements when compared to
 %% delivered_cache so we only check the former in the guard.
 maybe_flush_pre_publish_cache(JournalSizeHint,
                               #qistate{pre_publish_cache = PPC} = State)