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 18CEFA034C; Sat, 26 Feb 2022 10:37:49 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A3F5E4068F; Sat, 26 Feb 2022 10:37:48 +0100 (CET) Received: from mail-io1-f45.google.com (mail-io1-f45.google.com [209.85.166.45]) by mails.dpdk.org (Postfix) with ESMTP id 9F86740395 for ; Sat, 26 Feb 2022 10:37:47 +0100 (CET) Received: by mail-io1-f45.google.com with SMTP id c23so9334524ioi.4 for ; Sat, 26 Feb 2022 01:37:47 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=x8Swf3svI+MWwpXbIiAmLkMesFRR6rrLHZOMl6YmWK8=; b=MlvQk4LQGUffR33ib0uNokkD7fMqvmwFNIU220Zlv3kbkKR4tn8ao7TpFSvC01JBzG Ii5cY83f+8aaTnH7n8svJ4gaXdOKbNbM0VWiDDZ3ddhE8b1gHz9scHINhWjxpQ1HeQ7I hshYQnoKpvGdXtFXmqJ5gDXzs63ox0aEpzKIPmovtxdmduRZ97kQCBr6GvAEvXPgTtvz SsYTsHGw9bCE3eYkYN7B7uq4YnbOJR02ebcOsLtnwnkIB72z0m15T6QXQBD17cloQ9PF d+i+C2C+GPNnJFZxVjLS2CUkiinWpzyyIFIlSfikOgiiY+CPgp5b7uZ5H2Z55fij/sLU 9E/w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=x8Swf3svI+MWwpXbIiAmLkMesFRR6rrLHZOMl6YmWK8=; b=vLuhQL9xDE7bm/kbewAGNcBySuBKpyuLzE51pq8s9B1yDEoTifoS3JONNYJrbwtGZj Aa6AIZUM673K1Eu1XPPwJcDNmNfZezxADuwkFHqW4IfhRRrW2IAP2KAofHFpt3ucWcFc R+WlYuh2K0xKcp1okGSGRBfGg6d19keSuGP5yMl981i6tT5GDW9R7+4bogTtbazpv7Rr XGtLpK29imaHsVvw2VCNWsEX7+fTcfwRdmphxqgIPFdBocOuieReGPJV4ropCDaQgv3J cYxVrqyYykvo3JsAWu2Nz+2R4fcEtRWMO36c1UpvsPjdi5YERZaPvhXXYTEY9YbvqD0N Cfvw== X-Gm-Message-State: AOAM530qJy1xhIDpOKXgvmsRFkZp224+SrLk1/scj1McApxojpshtTS9 30da+4xVCd0uGZy9rDVybd5ES3PHQ5ZuHdvdybbfReKdOX2uLw== X-Google-Smtp-Source: ABdhPJzNikyYqXZ63hhtlW0wJED3wGKdkrgF6758wxOB2jqT/oPeOEGFHFKTujovT6fFjlS9pqG07t1MGw95EwHXkCQ= X-Received: by 2002:a05:6638:584:b0:311:9d1c:64b with SMTP id a4-20020a056638058400b003119d1c064bmr9525239jar.158.1645868266923; Sat, 26 Feb 2022 01:37:46 -0800 (PST) MIME-Version: 1.0 References: <20220207072932.22409-1-ndabilpuram@marvell.com> <20220222193512.19292-1-ndabilpuram@marvell.com> <20220222193512.19292-21-ndabilpuram@marvell.com> <1758600.8hzESeGDPO@thomas> In-Reply-To: <1758600.8hzESeGDPO@thomas> From: Jerin Jacob Date: Sat, 26 Feb 2022 15:07:20 +0530 Message-ID: Subject: Re: [PATCH v2 21/21] doc: add table for environment variables used by cnxk To: Thomas Monjalon Cc: Jerin Jacob , Nithin Dabilpuram , Kiran Kumar K , Sunil Kumar Kori , Satha Rao , dpdk-dev Content-Type: text/plain; charset="UTF-8" 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 Sat, Feb 26, 2022 at 2:52 PM Thomas Monjalon wrote: > > 22/02/2022 20:35, Nithin Dabilpuram: > > Add table for environment variables used by cnxk drivers. > > > > Signed-off-by: Nithin Dabilpuram > > --- > > +.. table:: cnxk environment variables > > + > > + +---+-----------------------------+-----------------------------------------+ > > + | # | Variable name | Usage | > > + +===+=============================+=========================================+ > > + | 1 | BPHY_INTR_MLOCK_DISABLE | When defined disables memory locking in | > > + | | | BPHY environment. | > > + +---+-----------------------------+-----------------------------------------+ > > + | 2 | ROC_CN10K_MBOX_TIMEOUT | When set, overrides MBOX timeout by | > > + | | ROC_MBOX_TIMEOUT | value in milli seconds. | > > + +---+-----------------------------+-----------------------------------------+ > > + | 3 | CN10K_ETH_SEC_IV_OVR | When set, overrides outbound inline SA | > > + | | | IV in CN10K. By default IV is generated | > > + | | | by HW. Format of variable is string | > > + | | | of comma separated one byte values as | > > + | | | for ex: "0x0, 0x10, 0x20, ..." | > > + +---+-----------------------------+-----------------------------------------+ > > Using tables for such list is a bad idea. > The source code is constrained in a small column, > and the HTML rendering is constrained by the page width. > I recommend switching to the definition list syntax > which has a nice rendering for such definitions. > > Example: > ``BPHY_INTR_MLOCK_DISABLE`` > Disable memory locking in BPHY environment. Sure, You can remove this doc update while merging to the main tree. We will submit a separate patch for updating this document based on your suggestion. > > See https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-blocks > >