From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 13E874235C; Wed, 11 Oct 2023 08:38:48 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 05585402E2; Wed, 11 Oct 2023 08:38:48 +0200 (CEST) Received: from mail.lysator.liu.se (mail.lysator.liu.se [130.236.254.3]) by mails.dpdk.org (Postfix) with ESMTP id 0CEB24028A; Wed, 11 Oct 2023 08:38:47 +0200 (CEST) Received: from mail.lysator.liu.se (localhost [127.0.0.1]) by mail.lysator.liu.se (Postfix) with ESMTP id 7F6781730; Wed, 11 Oct 2023 08:38:46 +0200 (CEST) Received: by mail.lysator.liu.se (Postfix, from userid 1004) id 656BF172F; Wed, 11 Oct 2023 08:38:46 +0200 (CEST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on hermod.lysator.liu.se X-Spam-Level: X-Spam-Status: No, score=-1.5 required=5.0 tests=ALL_TRUSTED,AWL autolearn=disabled version=3.4.6 X-Spam-Score: -1.5 Received: from [192.168.1.59] (h-62-63-215-114.A163.priv.bahnhof.se [62.63.215.114]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-256) server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mail.lysator.liu.se (Postfix) with ESMTPSA id 1C17916B9; Wed, 11 Oct 2023 08:38:44 +0200 (CEST) Message-ID: Date: Wed, 11 Oct 2023 08:38:43 +0200 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v6 3/3] doc: add dispatcher programming guide Content-Language: en-US To: David Marchand , =?UTF-8?Q?Mattias_R=C3=B6nnblom?= Cc: dev@dpdk.org, Jerin Jacob , techboard@dpdk.org, harry.van.haaren@intel.com, Peter Nilsson , Heng Wang , Naga Harish K S V , Pavan Nikhilesh , Gujjar Abhinandan S , Erik Gabriel Carrillo , Shijith Thotton , Hemant Agrawal , Sachin Saxena , Liang Ma , Peter Mccarthy , Zhirun Yan References: <20230928073056.359356-2-mattias.ronnblom@ericsson.com> <20231009181711.440865-1-mattias.ronnblom@ericsson.com> <20231009181711.440865-4-mattias.ronnblom@ericsson.com> From: =?UTF-8?Q?Mattias_R=C3=B6nnblom?= In-Reply-To: Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit X-Virus-Scanned: ClamAV using ClamSMTP X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On 2023-10-10 15:31, David Marchand wrote: > On Mon, Oct 9, 2023 at 8:23 PM Mattias Rönnblom > wrote: > > [snip] > >> +A module may use more than one event handler, for convenience or to >> +further decouple sub-modules. However, the dispatcher may impose an >> +upper limit of the number handlers. In addition, installing a large >> +number of handlers increase dispatcher overhead, although this does >> +not nessarily translate to a system-level performance degradation. See > > necessarily* > Will fix. > [snip] > >> +Event Clustering >> +^^^^^^^^^^^^^^^^ >> + >> +The dispatcher maintains the order of events destined for the same >> +handler. >> + >> +*Order* here refers to the order in which the events were delivered >> +from the event device to the dispatcher (i.e., in the event array >> +populated by ``rte_event_dequeue_burst()``), in relation to the order >> +in which the dispatcher deliveres these events to the application. >> + >> +The dispatcher *does not* guarantee to maintain the order of events >> +delivered to *different* handlers. >> + >> +For example, assume that ``MODULE_A_QUEUE_ID`` expands to the value 0, >> +and ``MODULE_B_STAGE_0_QUEUE_ID`` expands to the value 1. Then >> +consider a scenario where the following events are dequeued from the >> +event device (qid is short for event queue id). >> + >> +.. code-block:: > > Surprisingly, Ubuntu in GHA sphinx complains about this code-block > directive while generating on my Fedora runs fine... > > FAILED: doc/guides/html > /usr/bin/python3 ../buildtools/call-sphinx-build.py > /usr/bin/sphinx-build 23.11.0-rc0 > /home/runner/work/dpdk/dpdk/doc/guides > /home/runner/work/dpdk/dpdk/build/doc/guides -a -W > > Warning, treated as error: > /home/runner/work/dpdk/dpdk/doc/guides/prog_guide/dispatcher_lib.rst:253:Error > in "code-block" directive: > 1 argument(s) required, 0 supplied. > > .. code-block:: > > [e0: qid=1], [e1: qid=1], [e2: qid=0], [e3: qid=1] > > Looking at https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block, > I suspect there is probably a difference in the default settings of > sphinx in those Ubuntu containers. > > This is pseudo-code / close to C, so we could probably mark this block > as "C", but "none" works fine too. > WDYT? > > I'm also running Ubuntu, and thus didn't experience this issue. "none" seems better to me, to avoid potential future failures of syntax highlighting. Thanks!