Skip to content

Commit

Permalink
FmpDevicePkg: Fix links in FmpDxe (#161)
Browse files Browse the repository at this point in the history
## Description

Links are invalid causing a lint failure when moving to markdownlint
0.32.2:

```
FmpDevicePkg/FmpDxe/ReadMe.md:57:1 MD052/reference-links-images
  Reference links and images should use a label that is defined
  [Missing link or image reference definition:
   "fmpdevicepkg/library/fmpdependencychecklib/readme.md"]

FmpDevicePkg/FmpDxe/ReadMe.md:58:1 MD052/reference-links-images
  Reference links and images should use a label that is defined
  [Missing link or image reference definition:
   "fmpdevicepkg/library/fmpdependencylib/readme.md"]
```

Links are fixed in this change.

- [ ] Impacts functionality?
- **Functionality** - Does the change ultimately impact how firmware
functions?
- Examples: Add a new library, publish a new PPI, update an algorithm,
...
- [ ] Impacts security?
- **Security** - Does the change have a direct security impact on an
application,
    flow, or firmware?
  - Examples: Crypto algorithm change, buffer overflow fix, parameter
    validation improvement, ...
- [ ] Breaking change?
- **Breaking change** - Will anyone consuming this change experience a
break
    in build or boot behavior?
- Examples: Add a new library class, move a module to a different repo,
call
    a function in a new library class in a pre-existing module, ...
- [ ] Includes tests?
  - **Tests** - Does the change include any explicit test code?
  - Examples: Unit tests, integration tests, robot tests, ...
- [ ] Includes documentation?
- **Documentation** - Does the change contain explicit documentation
additions
    outside direct code modifications (and comments)?
- Examples: Update readme file, add feature readme file, link to
documentation
    on an a separate Web page, ...

## How This Was Tested

Tested against markdownlint 0.32.2.

## Integration Instructions

N/A

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
  • Loading branch information
makubacki authored and kenlautner committed Oct 23, 2023
1 parent e3bbc2b commit ea585d2
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions FmpDevicePkg/FmpDxe/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,9 @@ More information about the overall infrastructure is available in:
[Tianocore wiki: Fmp Capsule Dependency Introduction](https://github.com/tianocore/tianocore.github.io/wiki/Fmp-Capsule-Dependency-Introduction)

More details regarding the libraries in `FmpDevicePkg` are available in the respective ReadMe files:
[FmpDevicePkg/Library/FmpDependencyCheckLib][FmpDevicePkg/Library/FmpDependencyCheckLib/ReadMe.md](../Library/FmpDependencyCheckLib/ReadMe.md)
[FmpDevicePkg/Library/FmpDependencyLib][FmpDevicePkg/Library/FmpDependencyLib/ReadMe.md](../Library/FmpDependencyLib/ReadMe.md)

- [FmpDevicePkg/Library/FmpDependencyCheckLib](../Library/FmpDependencyCheckLib/ReadMe.md)
- [FmpDevicePkg/Library/FmpDependencyLib](../Library/FmpDependencyLib/ReadMe.md)

### Update Policy

Expand Down

0 comments on commit ea585d2

Please sign in to comment.