Split of the camera documentation #2667

naushir · 2022-10-24T12:16:27Z

Branch to split the camera documentation
Restructure camera documentation
camera: Update maximum exposure times
camera: Update sensor module table
camera: Remove "Software Features" section
camera: Minor updates to the camera guide

Move the camera software documentation into a new section under Computres. Keep the camera hardware documenation in the existing Accessories space. Signed-off-by: Naushir Patuck <naush@raspberrypi.com>

Update the maximum exposure time numbers, and while at it, fold the table into the hardware comparison table above. Signed-off-by: Naushir Patuck <naush@raspberrypi.com>

- Remove Linux integration and C programming API rows - Update resolution list for imx219 and imx477 - Add imx477 sensor size Signed-off-by: Naushir Patuck <naush@raspberrypi.com>

This does not belong in any camera documentation section. It ought to be re-instated in a future product sheet or product brief section. Signed-off-by: Naushir Patuck <naush@raspberrypi.com>

- s/Raspberry Pi is transitioning/Raspberry Pi has transitioned/ - Add audio-samplerate commandline option for libcamera-vid - Add dependencies for libav integration Signed-off-by: Naushir Patuck <naush@raspberrypi.com>

naushir · 2022-10-24T12:17:03Z

@aallan here's a first pass at moving the camera documentation around.

Signed-off-by: Naushir Patuck <naush@raspberrypi.com>

ghost · 2022-10-24T13:39:24Z

documentation/asciidoc/computers/camera/camera_usage.adoc


 === `libcamera` and the legacy _Raspicam_ camera stack

 [NOTE]
 ====
-Raspberry Pi is transitioning from a legacy camera software stack based on proprietary Broadcom GPU code to an open-source stack based on `libcamera`. Raspberry Pi OS images from _Bullseye_ onwards will contain *only* the `libcamera`-based stack. Raspberry Pi OS images up to and including _Buster_ will contain the legacy _Raspicam_ stack, though the `libcamera` stack and applications can be installed xref:camera.adoc#libcamera-and-libcamera-apps-packages[using _apt_], or built by following the xref:camera.adoc#building-libcamera-and-libcamera-apps[normal build instructions].
+Raspberry Pi has transitioned from a legacy camera software stack based on proprietary Broadcom GPU code to an open-source stack based on `libcamera`. Raspberry Pi OS images from _Bullseye_ onwards will contain *only* the `libcamera`-based stack. Raspberry Pi OS images up to and including _Buster_ will contain the legacy _Raspicam_ stack, though the `libcamera` stack and applications can be installed xref:camera.adoc#libcamera-and-libcamera-apps-packages[using _apt_], or built by following the xref:camera.adoc#building-libcamera-and-libcamera-apps[normal build instructions].


Probably this should get more extensive rewording. Perhaps also an admonition block, maybe something like:

NOTE: The lgacy firmware-based camera stack, including raspicam, has been deprecated and will be removed in a future version of Raspberry Pi OS. To use the legacy camera stack, enable it using the raspi-config utility: select legacy camera under interface options.

will be removed in a future version of Raspberry Pi OS

It has already been removed in the current version of Raspberry Pi OS: "Raspberry Pi OS images from Bullseye onwards will contain only the libcamera-based stack".

Probably this should get more extensive rewording. Perhaps also an admonition block, maybe something like:

NOTE: The lgacy firmware-based camera stack, including raspicam, has been deprecated and will be removed in a future version of Raspberry Pi OS. To use the legacy camera stack, enable it using the raspi-config utility: select legacy camera under interface options.

Hey. We're not really looking for external feedback on this branch at this time. Sorry.

Probably this should get more extensive rewording

TBH, I don't really know what more I would change in the above paragraph. Suggestions?

Probably this should get more extensive rewording. Perhaps also an admonition block, maybe something like:
NOTE: The lgacy firmware-based camera stack, including raspicam, has been deprecated and will be removed in a future version of Raspberry Pi OS. To use the legacy camera stack, enable it using the raspi-config utility: select legacy camera under interface options.

Hey. We're not really looking for external feedback on this branch at this time. Sorry.

Not a problem. As you were.

lurch · 2022-10-24T14:50:10Z

As we now have both documentation/asciidoc/accessories/camera.adoc and documentation/asciidoc/computers/camera.adoc I wonder if it might make sense to rename the latter to documentation/asciidoc/computers/camera_software.adoc ? 🤷

aallan · 2022-10-24T14:53:02Z

As we now have both documentation/asciidoc/accessories/camera.adoc and documentation/asciidoc/computers/camera.adoc I wonder if it might make sense to rename the latter to documentation/asciidoc/computers/camera_software.adoc ? 🤷

Maybe. The file name isn't really exposed in the text though, so it's "just" a backend thing that we can do at any point.

naushir · 2022-10-24T14:53:04Z

As we now have both documentation/asciidoc/accessories/camera.adoc and documentation/asciidoc/computers/camera.adoc I wonder if it might make sense to rename the latter to documentation/asciidoc/computers/camera_software.adoc ? 🤷

Sure, I can do that change.

aallan · 2022-10-24T14:55:21Z

Thanks for this @naushir. Just getting out of bed here in California, so I'll take a proper look at this after breakfast. Potentially we do minimal changes in this initial split, merge this in, and then the rewriting happens on a new branch after the merge?

naushir · 2022-10-24T14:56:28Z

Thanks for this @naushir. Just getting out of bed here in California, so I'll take a proper look at this after breakfast. Potentially we do minimal changes in this initial split, merge this in, and then the rewriting happens on a new branch after the merge?

Ok, I'll leave this change as-is for now and if any crucial amendments need to be made before merging, let me know.

aallan · 2022-10-24T16:52:34Z

Hey @naushir. You did your PR from your fork of the repo onto develop rather than the camera_branch so I've changed the base branch for the PR.

aallan · 2022-10-24T16:53:43Z

I'll now merge this onto the camera_branch and we can take a look on that branch how things look, work on branch, and then merge the camera_branch back to develop when we're ready to go, and hence to master and onto the live site?

aallan · 2022-10-24T17:01:43Z

This looks like a good first cut to me.

Looking at it, I think @lurch is right and the camera.adoc file in Computers should probably get a rename, to camera_software.adoc to make xref:'s across the pages cleaner.

We also need some linking text between the two pages, and the raspicam stuff needs to get moved to the end and get a big DEPRECATED warning box stuck on it.

How much new material do you think there is to go in @naushir ?

naushir · 2022-10-25T08:03:07Z

This looks like a good first cut to me.

Looking at it, I think @lurch is right and the camera.adoc file in Computers should probably get a rename, to camera_software.adoc to make xref:'s across the pages cleaner.

Sure, I'll make that change.

We also need some linking text between the two pages, and the raspicam stuff needs to get moved to the end and get a big DEPRECATED warning box stuck on it.

There is a cross link between pages ("Preparing the SW" from the accessories page, and "Once installed..." from the camera software page). Perhaps this need to be more explicit?

I'll also move the Raspicam stuff right to the end of the document.

How much new material do you think there is to go in @naushir ?

Nothing more for now... I'll look though again, but I think I've made all the amendments required.

naushir · 2022-10-25T09:39:51Z

@aallan and @lurch I've done something a bit silly unfortunately.

I failed to see that this PR had already been merged into https://github.com/raspberrypi/documentation/tree/camera_branch. and I've gone ahead and made the above suggestions (including a bunch of file renames) in my branch at https://github.com/naushir/documentation/tree/camera. This is a non-FF merge, and overwrites changes in the existing PR :-(

We could either force push the changes to camera_branch, or (preferably) removing the existing camera_branch and I create a new PR for camera_branch with my latest set of changes. What do you think?

aallan · 2022-10-25T15:02:17Z

I'll leave it to @lurch to decide what's the best approach. His Git skills are superior to mine. Andrew?

naushir · 2022-10-26T07:35:09Z

One option would be for either of you to create a new branch on here called camera_branch_v2, with the tip at 7b621a4. I can then create a PR with all my changes for camera_branch_v2 as normal, and we abandon camera_branch.

naushir · 2022-10-26T07:36:04Z

If that is too troublesome, I can redo my work and base it on top of camera_branch. Let me know.

lurch · 2022-10-27T11:01:13Z

One option would be for either of you to create a new branch on here called camera_branch_v2, with the tip at 7b621a4.

I've (hopefully) just done this - let me know if it doesn't look right!

naushir · 2022-10-27T11:40:07Z

Great, I'll push the PR now...

naushir · 2022-10-27T11:46:24Z

See new PR at #2673

aallan · 2022-10-27T15:14:17Z

Closing in favour of #2673.

naushir added 5 commits October 24, 2022 10:22

Restructure camera documentation

6062b45

Move the camera software documentation into a new section under Computres. Keep the camera hardware documenation in the existing Accessories space. Signed-off-by: Naushir Patuck <naush@raspberrypi.com>

camera: Update maximum exposure times

e847ffc

Update the maximum exposure time numbers, and while at it, fold the table into the hardware comparison table above. Signed-off-by: Naushir Patuck <naush@raspberrypi.com>

camera: Update sensor module table

0980e4a

- Remove Linux integration and C programming API rows - Update resolution list for imx219 and imx477 - Add imx477 sensor size Signed-off-by: Naushir Patuck <naush@raspberrypi.com>

camera: Remove "Software Features" section

5eca028

This does not belong in any camera documentation section. It ought to be re-instated in a future product sheet or product brief section. Signed-off-by: Naushir Patuck <naush@raspberrypi.com>

camera: Minor updates to the camera guide

38a0df6

- s/Raspberry Pi is transitioning/Raspberry Pi has transitioned/ - Add audio-samplerate commandline option for libcamera-vid - Add dependencies for libav integration Signed-off-by: Naushir Patuck <naush@raspberrypi.com>

camera: Remove unused introduction.adoc

2e63d66

Signed-off-by: Naushir Patuck <naush@raspberrypi.com>

ghost reviewed Oct 24, 2022

View reviewed changes

aallan changed the title ~~camera~~ Split of the camera documentation Oct 24, 2022

aallan added enhancement in progress documentation camera 📷 labels Oct 24, 2022

aallan changed the base branch from develop to camera_branch October 24, 2022 16:51

aallan merged commit cd4cb87 into raspberrypi:camera_branch Oct 24, 2022

aallan removed the in progress label Oct 24, 2022

aallan mentioned this pull request Oct 27, 2022

Split out camera documentation v2 #2673

Merged

aallan added the duplicate label Oct 27, 2022

Split of the camera documentation #2667

Split of the camera documentation #2667

Uh oh!

Conversation

naushir commented Oct 24, 2022

Uh oh!

naushir commented Oct 24, 2022

Uh oh!

ghost Oct 24, 2022 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lurch Oct 24, 2022

Choose a reason for hiding this comment

Uh oh!

aallan Oct 24, 2022

Choose a reason for hiding this comment

Uh oh!

naushir Oct 24, 2022

Choose a reason for hiding this comment

Uh oh!

ghost Oct 24, 2022

Choose a reason for hiding this comment

Uh oh!

lurch commented Oct 24, 2022

Uh oh!

aallan commented Oct 24, 2022

Uh oh!

naushir commented Oct 24, 2022

Uh oh!

aallan commented Oct 24, 2022

Uh oh!

naushir commented Oct 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aallan commented Oct 24, 2022

Uh oh!

aallan commented Oct 24, 2022

Uh oh!

aallan commented Oct 24, 2022

Uh oh!

naushir commented Oct 25, 2022

Uh oh!

naushir commented Oct 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aallan commented Oct 25, 2022

Uh oh!

naushir commented Oct 26, 2022

Uh oh!

naushir commented Oct 26, 2022

Uh oh!

lurch commented Oct 27, 2022

Uh oh!

naushir commented Oct 27, 2022

Uh oh!

naushir commented Oct 27, 2022

Uh oh!

aallan commented Oct 27, 2022

Uh oh!

Uh oh!

ghost Oct 24, 2022 •

edited by ghost

Loading

naushir commented Oct 24, 2022 •

edited

Loading

naushir commented Oct 25, 2022 •

edited

Loading