Re: [dpdk-dev] [PATCH v2] doc: update bnxt guide

[Ferruh Yigit <ferruh.yigit@intel.com>]

On 5/15/2020 10:56 PM, Ajit Khaparde wrote:
>     - Update list of supported adapters.
>     - Update list of supported features.
>     - Add some details to describe the features.
>     - Remove obsolete limitations.
>     - Fix and update links.
> 
> Signed-off-by: JP Lee <jongpil.lee@broadcom.com>
> Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> Acked-by: Kovacevic, Marko <marko.kovacevic@intel.com>

<...>

> +Extended Stats
> +~~~~~~~~~~~~~~
> +
> +Listed below are the extended stats supported by the BNXT PMD:
> +
> +* ``rx_good_packets``
> +* ``tx_good_packets``
> +* ``rx_good_bytes``
> +* ``tx_good_bytes``
> +* ``rx_missed_errors``
> +* ``rx_errors``
> +* ``tx_errors``
> +* ``rx_mbuf_allocation_errors``
> +* ``rx_q0packets``
> +* ``rx_q0bytes``
> +* ``rx_q0errors``
> +* ``tx_q0packets``
> +* ``tx_q0bytes``
> +* ``rx_64b_frames``
> +* ``rx_65b_127b_frames``
> +* ``rx_128b_255b_frames``
> +* ``rx_256b_511b_frames``
> +* ``rx_512b_1023b_frames``
> +* ``rx_1024b_1518b_frames``
> +* ``rx_good_vlan_frames``
> +* ``rx_1519b_2047b_frames``
> +* ``rx_2048b_4095b_frames``
> +* ``rx_4096b_9216b_frames``
> +* ``rx_9217b_16383b_frames``
> +* ``rx_total_frames``
> +* ``rx_ucast_frames``
> +* ``rx_mcast_frames``
> +* ``rx_bcast_frames``
> +* ``rx_fcs_err_frames``
> +* ``rx_ctrl_frames``
> +* ``rx_pause_frames``
> +* ``rx_pfc_frames``
> +* ``rx_unsupported_opcode_frames``
> +* ``rx_unsupported_da_pausepfc_frames``
> +* ``rx_wrong_sa_frames``
> +* ``rx_align_err_frames``
> +* ``rx_oor_len_frames``
> +* ``rx_code_err_frames``
> +* ``rx_false_carrier_frames``
> +* ``rx_ovrsz_frames``
> +* ``rx_jbr_frames``
> +* ``rx_mtu_err_frames``
> +* ``rx_match_crc_frames``
> +* ``rx_promiscuous_frames``
> +* ``rx_tagged_frames``
> +* ``rx_double_tagged_frames``
> +* ``rx_trunc_frames``
> +* ``rx_good_frames``
> +* ``rx_sch_crc_err_frames``
> +* ``rx_undrsz_frames``
> +* ``rx_frag_frames``
> +* ``rx_eee_lpi_events``
> +* ``rx_eee_lpi_duration``
> +* ``rx_llfc_physical_msgs``
> +* ``rx_llfc_logical_msgs``
> +* ``rx_llfc_msgs_with_crc_err``
> +* ``rx_hcfc_msgs``
> +* ``rx_hcfc_msgs_with_crc_err``
> +* ``rx_bytes``
> +* ``rx_runt_bytes``
> +* ``rx_runt_frames``
> +* ``rx_pfc_xon2xoff_frames_pri0``
> +* ``rx_pfc_xon2xoff_frames_pri1``
> +* ``rx_pfc_xon2xoff_frames_pri2``
> +* ``rx_pfc_xon2xoff_frames_pri3``
> +* ``rx_pfc_xon2xoff_frames_pri4``
> +* ``rx_pfc_xon2xoff_frames_pri5``
> +* ``rx_pfc_xon2xoff_frames_pri6``
> +* ``rx_pfc_xon2xoff_frames_pri7``
> +* ``rx_pfc_ena_frames_pri0``
> +* ``rx_pfc_ena_frames_pri1``
> +* ``rx_pfc_ena_frames_pri2``
> +* ``rx_pfc_ena_frames_pri3``
> +* ``rx_pfc_ena_frames_pri4``
> +* ``rx_pfc_ena_frames_pri5``
> +* ``rx_pfc_ena_frames_pri6``
> +* ``rx_pfc_ena_frames_pri7``
> +* ``rx_stat_discard``
> +* ``rx_stat_err``
> +* ``tx_64b_frames``
> +* ``tx_65b_127b_frames``
> +* ``tx_128b_255b_frames``
> +* ``tx_256b_511b_frames``
> +* ``tx_512b_1023b_frames``
> +* ``tx_1024b_1518b_frames``
> +* ``tx_good_vlan_frames``
> +* ``tx_1519b_2047b_frames``
> +* ``tx_2048b_4095b_frames``
> +* ``tx_4096b_9216b_frames``
> +* ``tx_9217b_16383b_frames``
> +* ``tx_good_frames``
> +* ``tx_total_frames``
> +* ``tx_ucast_frames``
> +* ``tx_mcast_frames``
> +* ``tx_bcast_frames``
> +* ``tx_pause_frames``
> +* ``tx_pfc_frames``
> +* ``tx_jabber_frames``
> +* ``tx_fcs_err_frames``
> +* ``tx_control_frames``
> +* ``tx_oversz_frames``
> +* ``tx_single_dfrl_frames``
> +* ``tx_multi_dfrl_frames``
> +* ``tx_single_coll_frames``
> +* ``tx_multi_coll_frames``
> +* ``tx_late_coll_frames``
> +* ``tx_excessive_coll_frames``
> +* ``tx_frag_frames``
> +* ``tx_err``
> +* ``tx_tagged_frames``
> +* ``tx_dbl_tagged_frames``
> +* ``tx_runt_frames``
> +* ``tx_fifo_underruns``
> +* ``tx_eee_lpi_events``
> +* ``tx_eee_lpi_duration``
> +* ``tx_total_collisions``
> +* ``tx_bytes``
> +* ``tx_pfc_ena_frames_pri0``
> +* ``tx_pfc_ena_frames_pri1``
> +* ``tx_pfc_ena_frames_pri2``
> +* ``tx_pfc_ena_frames_pri3``
> +* ``tx_pfc_ena_frames_pri4``
> +* ``tx_pfc_ena_frames_pri5``
> +* ``tx_pfc_ena_frames_pri6``
> +* ``tx_pfc_ena_frames_pri7``
> +* ``tx_llfc_logical_msgs``
> +* ``tx_hcfc_msgs``
> +* ``tx_xthol_frames``
> +* ``tx_stat_discard``
> +* ``tx_stat_error``
> +* ``tx_ucast_pkts``
> +* ``tx_mcast_pkts``
> +* ``tx_bcast_pkts``
> +* ``tx_discard_pkts``
> +* ``tx_drop_pkts``
> +* ``tx_ucast_bytes``
> +* ``tx_mcast_bytes``
> +* ``tx_bcast_bytes``
> +* ``rx_ucast_pkts``
> +* ``rx_mcast_pkts``
> +* ``rx_bcast_pkts``
> +* ``rx_discard_pkts``
> +* ``rx_drop_pkts``
> +* ``rx_ucast_bytes``
> +* ``rx_mcast_bytes``
> +* ``rx_bcast_bytes``
> +* ``rx_agg_pkts``
> +* ``rx_agg_bytes``
> +* ``rx_agg_events``
> +* ``rx_agg_aborts``
> +* ``link_down_events``
> +* ``continuous_pause_events``
> +* ``resume_pause_events``
> +* ``continuous_roce_pause_events``
> +* ``resume_roce_pause_events``
> +* ``rx_bytes_cos0``
> +* ``rx_bytes_cos1``
> +* ``rx_bytes_cos2``
> +* ``rx_bytes_cos3``
> +* ``rx_bytes_cos4``
> +* ``rx_bytes_cos5``
> +* ``rx_bytes_cos6``
> +* ``rx_bytes_cos7``
> +* ``rx_packets_cos0``
> +* ``rx_packets_cos1``
> +* ``rx_packets_cos2``
> +* ``rx_packets_cos3``
> +* ``rx_packets_cos4``
> +* ``rx_packets_cos5``
> +* ``rx_packets_cos6``
> +* ``rx_packets_cos7``
> +* ``pfc_pri0_rx_duration_us``
> +* ``pfc_pri0_rx_transitions``
> +* ``pfc_pri1_rx_duration_us``
> +* ``pfc_pri1_rx_transitions``
> +* ``pfc_pri2_rx_duration_us``
> +* ``pfc_pri2_rx_transitions``
> +* ``pfc_pri3_rx_duration_us``
> +* ``pfc_pri3_rx_transitions``
> +* ``pfc_pri4_rx_duration_us``
> +* ``pfc_pri4_rx_transitions``
> +* ``pfc_pri5_rx_duration_us``
> +* ``pfc_pri5_rx_transitions``
> +* ``pfc_pri6_rx_duration_us``
> +* ``pfc_pri6_rx_transitions``
> +* ``pfc_pri7_rx_duration_us``
> +* ``pfc_pri7_rx_transitions``
> +* ``rx_bits``
> +* ``rx_buffer_passed_threshold``
> +* ``rx_pcs_symbol_err``
> +* ``rx_corrected_bits``
> +* ``rx_discard_bytes_cos0``
> +* ``rx_discard_bytes_cos1``
> +* ``rx_discard_bytes_cos2``
> +* ``rx_discard_bytes_cos3``
> +* ``rx_discard_bytes_cos4``
> +* ``rx_discard_bytes_cos5``
> +* ``rx_discard_bytes_cos6``
> +* ``rx_discard_bytes_cos7``
> +* ``rx_discard_packets_cos0``
> +* ``rx_discard_packets_cos1``
> +* ``rx_discard_packets_cos2``
> +* ``rx_discard_packets_cos3``
> +* ``rx_discard_packets_cos4``
> +* ``rx_discard_packets_cos5``
> +* ``rx_discard_packets_cos6``
> +* ``rx_discard_packets_cos7``
> +* ``tx_bytes_cos0``
> +* ``tx_bytes_cos1``
> +* ``tx_bytes_cos2``
> +* ``tx_bytes_cos3``
> +* ``tx_bytes_cos4``
> +* ``tx_bytes_cos5``
> +* ``tx_bytes_cos6``
> +* ``tx_bytes_cos7``
> +* ``tx_packets_cos0``
> +* ``tx_packets_cos1``
> +* ``tx_packets_cos2``
> +* ``tx_packets_cos3``
> +* ``tx_packets_cos4``
> +* ``tx_packets_cos5``
> +* ``tx_packets_cos6``
> +* ``tx_packets_cos7``
> +* ``pfc_pri0_tx_duration_us``
> +* ``pfc_pri0_tx_transitions``
> +* ``pfc_pri1_tx_duration_us``
> +* ``pfc_pri1_tx_transitions``
> +* ``pfc_pri2_tx_duration_us``
> +* ``pfc_pri2_tx_transitions``
> +* ``pfc_pri3_tx_duration_us``
> +* ``pfc_pri3_tx_transitions``
> +* ``pfc_pri4_tx_duration_us``
> +* ``pfc_pri4_tx_transitions``
> +* ``pfc_pri5_tx_duration_us``
> +* ``pfc_pri5_tx_transitions``
> +* ``pfc_pri6_tx_duration_us``
> +* ``pfc_pri6_tx_transitions``
> +* ``pfc_pri7_tx_duration_us``
> +* ``pfc_pri7_tx_transitions``
> +* ``flow_0_bytes``
> +* ``flow_0_packets``
> +* ``...``
> +* ``flow_1023_bytes``
> +* ``flow_1023_packets``
> 

Hi Ajit,

Just recognized this part. This seems copy/paste of the extended stats, it does
not provide additional documenatation, and it is hard to keep these kind of
things up to date in long term.
It is up to you, but I suggest either just giving a high level information that
extendend stats are supported or provide a link to the code for the list of the
supported stats (that way it can always stay up to date).