[sr-dev] git:master:df6af83d: mqueue: doc updates for queue size

[Daniel-Constantin Mierla]

The name of the mandatory attribute is 'name', not 'value' -- it is
wrong now compared with the old content.

Cheers,
Daniel


On 12.07.17 19:34, Ovidiu Sas wrote:
> Module: kamailio
> Branch: master
> Commit: df6af83d627de3de4669c887065c3a5357fa5f7b
> URL: https://github.com/kamailio/kamailio/commit/df6af83d627de3de4669c887065c3a5357fa5f7b
>
> Author: Ovidiu Sas <osas at voipembedded.com>
> Committer: Ovidiu Sas <osas at voipembedded.com>
> Date: 2017-07-12T13:33:45-04:00
>
> mqueue: doc updates for queue size
>
> ---
>
> Modified: src/modules/mqueue/doc/mqueue.xml
> Modified: src/modules/mqueue/doc/mqueue_admin.xml
>
> ---
>
> Diff:  https://github.com/kamailio/kamailio/commit/df6af83d627de3de4669c887065c3a5357fa5f7b.diff
> Patch: https://github.com/kamailio/kamailio/commit/df6af83d627de3de4669c887065c3a5357fa5f7b.patch
>
> ---
>
> diff --git a/src/modules/mqueue/doc/mqueue.xml b/src/modules/mqueue/doc/mqueue.xml
> index 94b77fd913..53ce810056 100644
> --- a/src/modules/mqueue/doc/mqueue.xml
> +++ b/src/modules/mqueue/doc/mqueue.xml
> @@ -29,6 +29,12 @@
>  		<email>abalashov at evaristesys.com</email>
>  		<affiliation><orgname>Evariste Systems</orgname></affiliation>
>  	    </editor>
> +	    <editor>
> +		<firstname>Ovidiu</firstname>
> +		<surname>Sas</surname>
> +		<email>osas at voipembedded.com</email>
> +		<affiliation><orgname>VoIP Embedded, Inc.</orgname></affiliation>
> +	    </editor>
>  	</authorgroup>
>  	<copyright>
>  	    <year>2010</year>
> diff --git a/src/modules/mqueue/doc/mqueue_admin.xml b/src/modules/mqueue/doc/mqueue_admin.xml
> index dc8463b6e7..dfaec773d9 100644
> --- a/src/modules/mqueue/doc/mqueue_admin.xml
> +++ b/src/modules/mqueue/doc/mqueue_admin.xml
> @@ -72,10 +72,32 @@
>  		</emphasis>
>  	    </para>
>  		<para>
> -		Value must be a list of parameters: attr=value;... The attribute 'name'
> -		is mandatory, defining the name of the queue. Optional attribute 'size'
> -		specifies the maximum number of items in queue, if it is execeeded the
> -		oldest one is removed.
> +		Value must be a list of parameters: attr=value;...
> +		<itemizedlist>
> +		<listitem>
> +			<para>Mandatory attributes:</para>
> +			<itemizedlist>
> +			<listitem>
> +				<para>
> +				<emphasis>value</emphasis>: name of the queue.
> +				</para>
> +			</listitem>
> +			</itemizedlist>
> +		</listitem>
> +		<listitem>
> +			<para>Optional attributes:</para>
> +			<itemizedlist>
> +			<listitem>
> +				<para>
> +				<emphasis>size</emphasis>: size of the queue.
> +				Specifies the maximum number of items in queue.
> +				If execeeded the oldest one is removed.
> +				If not set the queue will be limitless.
> +				</para>
> +			</listitem>
> +			</itemizedlist>
> +		</listitem>
> +		</itemizedlist>
>  	    </para>
>  		<para>
>  		The parameter can be set many times, each holding the definition of one
>
>
> _______________________________________________
> Kamailio (SER) - Development Mailing List
> sr-dev at lists.kamailio.org
> https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev

-- 
Daniel-Constantin Mierla
www.twitter.com/miconda -- www.linkedin.com/in/miconda
Kamailio Advanced Training - www.asipto.com
Kamailio World Conference - www.kamailioworld.com