[v2,8/8] doc: drop EAL command-line reference from FreeBSD GSG
Checks
Commit Message
The EAL command-line reference section duplicated material covered in a
previous chapter, was out of date, and generally is unnecessary as options
are best queried directly by passing "--help" to a DPDK binary. Therefore
we can drop this section to avoid having to try and keep it up-to-date in
the future.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
.../freebsd_gsg/freebsd_eal_parameters.rst | 20 -------------------
doc/guides/freebsd_gsg/index.rst | 1 -
2 files changed, 21 deletions(-)
delete mode 100644 doc/guides/freebsd_gsg/freebsd_eal_parameters.rst
Comments
On 25-Nov-19 2:55 PM, Bruce Richardson wrote:
> The EAL command-line reference section duplicated material covered in a
> previous chapter, was out of date, and generally is unnecessary as options
> are best queried directly by passing "--help" to a DPDK binary. Therefore
> we can drop this section to avoid having to try and keep it up-to-date in
> the future.
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
While passing --help works, i believe the parameter guides are a little
bit more detailed than what you can put in a help message, so there
still is a place for those. FreeBSD doesn't have FreeBSD-specific
parameters, so in this case it's probably OK to drop this particular
document, but it would still be nice to refer users to the common EAL
arguments guide.
On Wed, Nov 27, 2019 at 12:31:10PM +0000, Burakov, Anatoly wrote:
> On 25-Nov-19 2:55 PM, Bruce Richardson wrote:
> > The EAL command-line reference section duplicated material covered in a
> > previous chapter, was out of date, and generally is unnecessary as options
> > are best queried directly by passing "--help" to a DPDK binary. Therefore
> > we can drop this section to avoid having to try and keep it up-to-date in
> > the future.
> >
> > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> > ---
>
> While passing --help works, i believe the parameter guides are a little bit
> more detailed than what you can put in a help message, so there still is a
> place for those. FreeBSD doesn't have FreeBSD-specific parameters, so in
> this case it's probably OK to drop this particular document, but it would
> still be nice to refer users to the common EAL arguments guide.
>
Ok. Let's drop this patch from the set for 19.11, then.
/Bruce
deleted file mode 100644
@@ -1,20 +0,0 @@
-.. SPDX-License-Identifier: BSD-3-Clause
- Copyright(c) 2018 Intel Corporation.
-
-EAL parameters
-==============
-
-This document contains a list of all EAL parameters. These parameters can be
-used by any DPDK application running on FreeBSD.
-
-Common EAL parameters
----------------------
-
-The following EAL parameters are common to all platforms supported by DPDK.
-
-.. include:: ../linux_gsg/eal_args.include.rst
-
-FreeBSD-specific EAL parameters
--------------------------------
-
-There are currently no FreeBSD-specific EAL command-line parameters available.
@@ -14,4 +14,3 @@ Getting Started Guide for FreeBSD
install_from_ports
build_dpdk
build_sample_apps
- freebsd_eal_parameters