diff options
| author |   Billy McFall <bmcfall@redhat.com> | 2017-02-10 14:57:24 -0500 |
|---|---|---|
| committer |   Damjan Marion <dmarion.lists@gmail.com> | 2017-02-14 12:28:47 +0000 |
| commit | 33e2dc078b4cc7eb32a829180bd8a58ec5aafc90 (patch) | |
| tree | 4a1c394c79cc60ea5727358bdefae304911197e4 /src/vnet/devices/dpdk/dir.dox | |
| parent | d3ba515d99551ee87096931b34a5b8d4222b385d (diff) | |
VPP-279: Document changes for vnet/vnet/devices
Add doxygen documentation for pcap tx trace CLI command.
In the process of adding the documentation, made the following changes
to the way the command worked:
* If there is an error with any of the attributes, the whole command
fails. The existing behavior was to apply attribute by attribute,
then bail if there was an issue, with partial apply.
* Move the 'on' processing to the end. The existing behavior was to
process the 'on' as it was encountered on the commandline. That meant
that any attributes after the 'on' in the commandline were saved and
displayed, but not really being used in the packet trace.
* Enhanced the 'status' to show all the configured attributes.
NOTE: The packet capture has some weird behavior with regards to how
many packets are written to file and if the file is appended or
overwritten. VPP-634 written to document the issue.
Change-Id: Iab241228b125385052de242865afd9515fa2524f
Signed-off-by: Billy McFall <bmcfall@redhat.com>
Diffstat (limited to 'src/vnet/devices/dpdk/dir.dox')
| -rw-r--r-- | src/vnet/devices/dpdk/dir.dox | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/src/vnet/devices/dpdk/dir.dox b/src/vnet/devices/dpdk/dir.dox new file mode 100644 index 00000000000..43e36753245 --- /dev/null +++ b/src/vnet/devices/dpdk/dir.dox @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/* Doxygen directory documentation */ + +/** +@dir +@brief DPDK Abstraction Layer. + +This directory contains the source code for the DPDK abstraction layer. + +*/ +/*? %%clicmd:group_label DPDK and pcap tx %% ?*/ +/*? %%syscfg:group_label DPDK and pcap tx %% ?*/ |