diff mbox series

[v3,36/36] net/e1000: update e1000 documentation

Message ID fc40dbf6c4eb68aa1954d4843e6d41c3ef0a659f.1738932115.git.anatoly.burakov@intel.com (mailing list archive)
State Accepted
Delegated to: Bruce Richardson
Headers
Series Merge Intel IGC and E1000 drivers, and update E1000 base code |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation warning apply issues

Commit Message

Burakov, Anatoly Feb. 7, 2025, 12:45 p.m. UTC 
Now that the base code has been brought up to date, update the docs to
call this out.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
---
 doc/guides/rel_notes/release_25_03.rst | 1 +
 drivers/net/intel/e1000/base/README    | 6 +++---
 2 files changed, 4 insertions(+), 3 deletions(-)

Comments

Bruce Richardson Feb. 7, 2025, 5:31 p.m. UTC | #1 
On Fri, Feb 07, 2025 at 12:45:28PM +0000, Anatoly Burakov wrote:
> Now that the base code has been brought up to date, update the docs to
> call this out.
> 
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
> ---
>  doc/guides/rel_notes/release_25_03.rst | 1 +
>  drivers/net/intel/e1000/base/README    | 6 +++---
>  2 files changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/release_25_03.rst b/doc/guides/rel_notes/release_25_03.rst
> index 341fdb9a37..82d72714f1 100644
> --- a/doc/guides/rel_notes/release_25_03.rst
> +++ b/doc/guides/rel_notes/release_25_03.rst
> @@ -96,6 +96,7 @@ New Features
>  * **Updated Intel e1000 driver.**
>  
>     * Added support for the Intel i225-series NICs (previously handled by net/igc).
> +   * Updated base code to the latest version.
>  
>  Removed Items
>  -------------
> diff --git a/drivers/net/intel/e1000/base/README b/drivers/net/intel/e1000/base/README
> index 5d083a0e48..2a0696f3c4 100644
> --- a/drivers/net/intel/e1000/base/README
> +++ b/drivers/net/intel/e1000/base/README
> @@ -2,9 +2,9 @@
>   * Copyright(c) 2010-2020 Intel Corporation
>   */
>  
> -This directory contains source code of FreeBSD em, igb, and igc drivers of version
> -cid-gigabit.2020.06.05.tar.gz released by ND. The sub-directory of base/
> -contains the original source package.
> +This directory contains source code of FreeBSD em, igb, and igc drivers of
> +snapshot generated on 2025-01-24-09.44. The sub-directory of base/ contains the
> +original source package.
>  

I'm going to reword this on apply to something more similar to the other
base driver READMEs, since a) it's no longer a driver from FreeBSD and b) this
README is already in the "base" subdirectory.

"This directory contains source code of the base driver code for em/igb/igc,
with this snapshot generated on 2025-01-24-09.44."

Regards,
/Bruce
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/release_25_03.rst b/doc/guides/rel_notes/release_25_03.rst
index 341fdb9a37..82d72714f1 100644
--- a/doc/guides/rel_notes/release_25_03.rst
+++ b/doc/guides/rel_notes/release_25_03.rst
@@ -96,6 +96,7 @@  New Features
 * **Updated Intel e1000 driver.**
 
    * Added support for the Intel i225-series NICs (previously handled by net/igc).
+   * Updated base code to the latest version.
 
 Removed Items
 -------------
diff --git a/drivers/net/intel/e1000/base/README b/drivers/net/intel/e1000/base/README
index 5d083a0e48..2a0696f3c4 100644
--- a/drivers/net/intel/e1000/base/README
+++ b/drivers/net/intel/e1000/base/README
@@ -2,9 +2,9 @@ 
  * Copyright(c) 2010-2020 Intel Corporation
  */
 
-This directory contains source code of FreeBSD em, igb, and igc drivers of version
-cid-gigabit.2020.06.05.tar.gz released by ND. The sub-directory of base/
-contains the original source package.
+This directory contains source code of FreeBSD em, igb, and igc drivers of
+snapshot generated on 2025-01-24-09.44. The sub-directory of base/ contains the
+original source package.
 
 This driver is valid for the product(s) listed below
 * Intel® Ethernet Controller 82540