[PATCH V7] ethdev: fix one address occupies two entries in MAC addrs

Thomas Monjalon thomas at monjalon.net
Thu Feb 2 12:50:38 CET 2023


02/02/2023 02:11, lihuisong (C):
> 在 2023/2/2 0:37, Thomas Monjalon 写道:
> > 01/02/2023 14:15, Huisong Li:
> >>      This section is a comment. Do not overwrite or remove it.
> >>      Also, make sure to start the actual text at the margin.
> >>      =======================================================
> > Please check the comment: "make sure to start the actual text at the margin."
> 
> It means to start the actual text  at the beginning of the line, right?

It means no extra space at the beginning of the line.

> >> -	/** Device Ethernet link address. @see rte_eth_dev_release_port() */
> >> +	/**
> >> +	 * Device Ethernet link addresses.
> >> +	 * All entries are unique. The first entry (index zero) is the
> >> +	 * default address.
> >> +	 */
> > You remember I asked to split lines after the dot?
> Sorry for my misunderstanding. Need to occupy one line for each sentence 
> here?

A sentence may be longer than one line,
but it is better split lines logically (after dots, commas, etc).

> Do we generally use this style to make comments? or are we just trying 
> to highlight it here?

That's a recommendation when writing text (comments and rst doc).
Having lines split logically may help reading,
and will make simpler patches when updating in future,
because in general we change a single sentence.





More information about the dev mailing list