Skip to content

Commit

Permalink
Fixed markdown issues that changes from edk2 brought
Browse files Browse the repository at this point in the history
  • Loading branch information
kenlautner committed Jul 3, 2024
1 parent 40b27b1 commit b1c198a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
12 changes: 10 additions & 2 deletions MdePkg/Library/MipiSysTLib/Readme.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,32 @@
## Introduction of MipiSysTLib ##
# Introduction of MipiSysTLib #

MipiSysTLib library is a upper level library consuming MIPI SYS-T submodule.
It provides MIPI-related APIs in EDK2 format to be consumed.

## MipiSysTLib Version ##

EDK2 supports building with v1.1+edk2 official version which was fully validated.

## HOW to Install MipiSysTLib for UEFI Building ##

MIPI SYS-T repository was added as a submodule of EDK2 project. Please
refer to edk2/Readme.md for how to clone the code.

## About GenMipiSystH.py ##

"GenMipiSystH.py" is a Python script which is used for customizing the
mipi_syst.h.in in mipi sys-T repository. The resulting file, mipi_syst.h, will
be put to same folder level as this script.
```

```text
mipisyst submodule MipiSysTLib library
|---------------------| GenMipiSystH.py |---------------------|
| mipi_syst.h.in |-----------------> | mipi_syst.h |
|---------------------| |---------------------|
```

This script needs to be done once by a developer when adding some
project-related definition or a new version of mipi_syst.h.in was released.
Normal users do not need to do this, since the resulting file is stored
Expand Down
6 changes: 6 additions & 0 deletions MdePkg/MdePkg.ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -194,5 +194,11 @@
"Library/BaseFdtLib/string.h",
"mipi_syst.h"
]
},

## options defined .pytool/Plugin/MarkdownLintCheck
"MarkdownLintCheck": {
"IgnoreFiles": [ "Library/MipiSysTLib/mipisyst" # submodule outside of control
] # package root relative file, folder, or glob pattern to ignore
}
}

0 comments on commit b1c198a

Please sign in to comment.