From patchwork Tue Oct 17 12:13:09 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 266 Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 72FD24318A; Tue, 17 Oct 2023 14:13:28 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 170584029E; Tue, 17 Oct 2023 14:13:28 +0200 (CEST) Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.31]) by mails.dpdk.org (Postfix) with ESMTP id ED66E40273 for ; Tue, 17 Oct 2023 14:13:25 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1697544806; x=1729080806; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=pnM02qEVLafaXUMXTHqYtv7E84c2Wr/9Nikhhyi7+Uw=; b=U/WsqVupO1uWgGERD4uqpxxM5uscVx/NwzDBpySUVJtC7lPzlZA2ByKL tAdYGwal6w+HM2YzQ79VCy9ElJq/Gpe6mH8IN16k85GJQJdbLSwv1ufci lHwfK2so66YDqHOMCtZAC16no0xj+uFy3eVbVKylvjW+WA1bn72cAcO7W JiNaL2PKyhvdJjbYOH90BWRDcW+FDBsaM8i4UmPF760Tgz35HtUT30MZs amNTaM3HoYpYwrhHZKAky7T7mmqxeodH2/8hCt8RgmzT/ivuHS9fmSmWo qdzDCieUFZ4mWMeUQ6c0M9Wb/J/F9+07+EOtnnhaYN5s8myS0uM0JrGym g==; X-IronPort-AV: E=McAfee;i="6600,9927,10865"; a="449984761" X-IronPort-AV: E=Sophos;i="6.03,232,1694761200"; d="scan'208";a="449984761" Received: from fmviesa001.fm.intel.com ([10.60.135.141]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 17 Oct 2023 05:13:24 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.03,232,1694761200"; d="scan'208";a="4068798" Received: from unknown (HELO silpixa00401385.ir.intel.com) ([10.237.214.41]) by fmviesa001.fm.intel.com with ESMTP; 17 Oct 2023 05:13:28 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: david.marchand@redhat.com, rjarry@redhat.com, Bruce Richardson Subject: [PATCH v5 0/9] document and simplify use of cmdline Date: Tue, 17 Oct 2023 13:13:09 +0100 Message-Id: <20231017121318.146007-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230802170052.955323-1-bruce.richardson@intel.com> References: <20230802170052.955323-1-bruce.richardson@intel.com> MIME-Version: 1.0 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 The DPDK commandline library is widely used by apps and examples within DPDK, but it is not documented in our programmers guide and it requires a lot of boilerplate code definitions in order to used. We can improve this situation by creating a simple python script to automatically generate the boilerplate from a list of commands. This patchset contains a new documentation chapter on cmdline library, going through step-by-step how to add commands and create the necessary token lists and parse contexts. Following that initial doc patch, the set then contains a boilerplate-generating script, as well as a set of four patches showing its use, by converting four examples to use the script instead of having the hard-coded boilerplate. Once the script is used, adding a new command becomes as simple as adding the desired command to the .list file, and then writing the required function which will be called for that command. No other boilerplate coding is necessary. Final two patches, new in V5, add support for option-lists in values, and then use that support to convert over a fifth sample app - ntb. Cmdline script obviously does not cover the full range of capabilities of the commandline lib, but does cover the most used parts. The code-saving to each of the examples by auto-generating the boilerplate is significant, and probably more examples with commandlines can be converted over in future. The "cmdline" example itself, is not converted over, as it should probably remain as a simple example of direct library use without the script. V5: * Added copyright headers to command list files * Add support for option lists * Convert examples/ntb to use script V4: * Reworked script following feedback from Robin J. - formatted code with black - used multi-line strings - replaced sys.exit(1) with proper error handling - per-command function returns lists rather than printing directly - other small cleanups * Added change to CI script so the cmdline script is in PATH * Converted VDPA example to script, saving another 100 LOC V3: * Added lots of documentation * Added support for help text for each command * Cleaned up script a little so it passes pycodestyle and most flake8 checks, when line-length is set to max 100. * Removed RFC tag, as I consider this patchset stable enough for consideration in a release. V2-RFC: * Add support for IP addresses in commands * Move to buildtools directory and make installable * Convert 3 examples to use script, and eliminate their boilerplate Bruce Richardson (9): doc/prog_guide: new chapter on cmdline library buildtools: script to generate cmdline boilerplate ci: allow use of DPDK tools when building examples examples/simple_mp: auto-generate cmdline boilerplate examples/hotplug_mp: auto-generate cmdline boilerplate examples/bond: auto-generate cmdline boilerplate examples/vdpa: auto-generate cmdline boilerplate buildtools/dpdk-cmdline-gen: support option strings examples/ntb: auto-generate cmdline boilerplate .ci/linux-build.sh | 1 + app/test/commands.c | 2 + buildtools/dpdk-cmdline-gen.py | 197 ++++++++ buildtools/meson.build | 7 + doc/guides/prog_guide/cmdline.rst | 470 ++++++++++++++++++ doc/guides/prog_guide/index.rst | 1 + examples/bond/Makefile | 12 +- examples/bond/commands.list | 6 + examples/bond/main.c | 161 +----- examples/bond/main.h | 10 - examples/bond/meson.build | 8 + examples/multi_process/hotplug_mp/Makefile | 12 +- examples/multi_process/hotplug_mp/commands.c | 147 +----- examples/multi_process/hotplug_mp/commands.h | 10 - .../multi_process/hotplug_mp/commands.list | 8 + examples/multi_process/hotplug_mp/meson.build | 9 + examples/multi_process/simple_mp/Makefile | 12 +- examples/multi_process/simple_mp/meson.build | 9 + .../multi_process/simple_mp/mp_commands.c | 106 +--- .../multi_process/simple_mp/mp_commands.h | 14 - .../multi_process/simple_mp/mp_commands.list | 6 + examples/ntb/Makefile | 12 +- examples/ntb/commands.list | 11 + examples/ntb/meson.build | 7 + examples/ntb/ntb_fwd.c | 200 +------- examples/vdpa/Makefile | 12 +- examples/vdpa/commands.list | 8 + examples/vdpa/main.c | 131 +---- examples/vdpa/meson.build | 7 + 29 files changed, 863 insertions(+), 733 deletions(-) create mode 100755 buildtools/dpdk-cmdline-gen.py create mode 100644 doc/guides/prog_guide/cmdline.rst create mode 100644 examples/bond/commands.list delete mode 100644 examples/bond/main.h delete mode 100644 examples/multi_process/hotplug_mp/commands.h create mode 100644 examples/multi_process/hotplug_mp/commands.list delete mode 100644 examples/multi_process/simple_mp/mp_commands.h create mode 100644 examples/multi_process/simple_mp/mp_commands.list create mode 100644 examples/ntb/commands.list create mode 100644 examples/vdpa/commands.list --- 2.39.2