Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FreeBSD/ARM Project: corrections, updates #215

Closed
wants to merge 8 commits into from

Conversation

grahamperrin
Copy link
Contributor

@grahamperrin grahamperrin commented Jul 9, 2023

Follow up to:

  • be0f286 FreeBSD/ARM Project: minor changes

In parallel:

Affects:

The reference to Brief history of ARM lacks detail. The linked server is unresponsive. Refer to a capture in the Wayback Machine, name the author, date the page and its capture, be true to the title of the presentation. 

It is probably no longer appropriate to describe the mini-install guide, which is more than thirteen years old, as for current FreeBSD source.

[[miniinst]]
== Mini-install Guide

{cognet} has written a mini-install guide for the current FreeBSD source. It is https://people.FreeBSD.org/~cognet/arm.html[available here].
From {cognet} in 2009:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar: a full stop is missing from the second paragraph of hardware notes. 

Style: close each list of items with a full stop. 

Markup: one sentence per line.
With FreeBSD/ARM Project as the title of the page (in the title bar of the web browser) and as the main heading, we do not need FreeBSD/ARM as a prefix to a subheading.
The phrase 'ARM ports' is easily misinterpreted as ports for (not of) FreeBSD on ARM. 

Give prominence to the mailing list. 

Be concise. 

Make the status more positive; absences of releases and of packages are not a good beginning. Be true; FreeBSD/ARM can not be described as a (generally) excellent framework where there are neither releases, nor packages. Reorder and rewrite this section of the page – not only for positivity, also for clarity. 

For a newcomer who might want a brief introduction to tiering, immediate direction to the Committer's Guide is less than welcoming (thrown in at the deep end). Instead, ease the reader into the shallow end – the platforms page, which includes links to the Committer's Guide (for experienced swimmers). 

Make the hardware notes overview more readable. 

Begin tidying what needs to be done.
Be concise. 

Contents, not Table of Contents.
Fix my 'a excellent' mistake.
Mention aarch64.

A mid-text link to the FreeBSD Project home page is unnecessary.
* SATA support needs to be added for boards currently missing it.
* Other devices, such as watchdog, i2c and bus should be merged from NetBSD.
* SATA support for some boards
* other devices, such as watchdog, i2c and bus, should be merged from NetBSD.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What?

Is bus – the three-letter word – the name of a device in NetBSD?

- https://wiki.freebsd.org/arm[FreeBSD ARM wiki pages]
- https://cgit.freebsd.org/src/tree/sys/arm/conf/[kernel configuration files].

Many CPUs and boards that are not listed below may work, with minimal changes.
Copy link
Contributor Author

@grahamperrin grahamperrin Jul 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes to what?

To source code for FreeBSD?

@grahamperrin grahamperrin marked this pull request as ready for review July 9, 2023 10:00
@@ -66,7 +75,7 @@ Listing all supported devices on all CPUs and boards is impractical here, howeve
* Samsung Exynos5 and S3C24xxx
* Texas Instruments DaVinci Digital Media SoC
* TI OMAP
* Xilinx Zynq7 family
* Xilinx Zynq7 family.

Note that not all peripherals are supported on all CPUs.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph seems superfluous, repetitive.

d5ecf98 (#215) forewarns that not every peripheral is supported on every CPU or board.

@@ -96,7 +105,7 @@ Note that not all peripherals are supported on all CPUs.
* SBC6045 with Atmel at91sam9g45
* Technologic Systems TS-7200 and TS-7800
* Wandboard
* Zedboard (Xilinx Zynq)
* Zedboard (Xilinx Zynq).

Not all peripherals are supported on all boards.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph seems superfluous, repetitive.

d5ecf98 (#215) forewarns that not every peripheral is supported on every CPU or board.

@grahamperrin grahamperrin deleted the freebsd-arm-project branch August 20, 2023 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants