Skip to content

Commit 818d5f5

Browse files
committed
Update docs related to entry point
1 parent 089e3e0 commit 818d5f5

File tree

2 files changed

+7
-10
lines changed

2 files changed

+7
-10
lines changed

BUILDING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,10 @@ The following steps allow you to build a simple UEFI app.
1818
and make sure you have an entry point function which matches the one below:
1919

2020
```rust
21-
#[no_mangle]
22-
pub extern "C" fn efi_main(handle: Handle, system_table: SystemTable<Boot>) -> Status;
21+
use uefi::prelude::*;
22+
23+
#[entry]
24+
fn efi_main(handle: Handle, system_table: SystemTable<Boot>) -> Status;
2325
```
2426

2527
- Build using `cargo xbuild --target x86_64-unknown-uefi`.

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,19 +82,14 @@ uses UEFI to set up an environment for it.
8282

8383
## Documentation
8484

85+
The docs for the latest published crate version can be found at
86+
[docs.rs/uefi/](https://docs.rs/uefi/)
87+
8588
This crate's documentation is fairly minimal, and you are encouraged to refer to
8689
the [UEFI specification][spec] for detailed information.
8790

8891
[spec]: http://www.uefi.org/specifications
8992

90-
### rustdoc
91-
92-
Use the `build.py` script in the `uefi-test-runner` directory to generate the documentation:
93-
94-
```sh
95-
./build.py doc
96-
```
97-
9893
## Sample code
9994

10095
An example UEFI app is built in the `uefi-test-runner` directory.

0 commit comments

Comments
 (0)