Docs: Make Cycles Args visible in --help #108232

Raimund Klink · 2023-05-24T15:28:21+02:00

Raimund Klink commented

2023-05-24 15:28:21 +02:00

The Cycles-specific command line arguments are currently hidden
on this page [1]. To make the command visible in the manual [2] and
in blender --help, I added this patch.

[1] https://docs.blender.org/manual/en/3.6/advanced/command_line/render.html#cycles
[2] https://docs.blender.org/manual/en/3.6/advanced/command_line/arguments.html#argument-order

If this gets merged, please merge blender/blender-manual#104455 as well.

The Cycles-specific command line arguments are currently hidden on this page [1]. To make the command visible in the manual [2] and in `blender --help`, I added this patch. [1] https://docs.blender.org/manual/en/3.6/advanced/command_line/render.html#cycles [2] https://docs.blender.org/manual/en/3.6/advanced/command_line/arguments.html#argument-order If this gets merged, please merge https://projects.blender.org/blender/blender-manual/pulls/104455 as well.

Raimund Klink added 5 commits 2023-05-24 15:28:28 +02:00

45859a854b cleanr_space

The little dent in the log annoyed me.

8409d75d32 Merge branch 'main' into main

d1cf8f731b Update source/blender/render/intern/pipeline.cc

08331f9b0e Update source/creator/creator_args.c

How to do ``?

cca8e095fb Update source/creator/creator_args.c

Raimund Klink referenced this pull request from blender/blender-manual

2023-05-24 15:30:42 +02:00

Docs: Move info to the correct page #104455

Raimund Klink requested review from Aaron Carlisle 2023-05-24 15:32:27 +02:00

Raimund Klink added 1 commit 2023-05-24 15:36:57 +02:00

b3a94ec113 Add # ifdef WITH_CYCLES

Raimund Klink added 1 commit 2023-05-24 17:17:49 +02:00

9d0c352f2e Update source/creator/creator_args.c

Aaron Carlisle requested changes 2023-05-25 04:43:20 +02:00

source/creator/creator_args.c Outdated

						
				@ -667,2 +667,4 @@

				  printf("\t...works as expected.\n\n");

				#  ifdef WITH_CYCLES

				  printf("Additional Cycles Arguments:\n");

Aaron Carlisle commented

2023-05-25 04:42:11 +02:00

Would call this "Cycles Render Options"

I would also move this content up, above // printf("Experimental Features:\n");

Would call this "Cycles Render Options" I would also move this content up, above `// printf("Experimental Features:\n");`

Raimund Klink commented

2023-05-25 08:26:38 +02:00

Done

Raimund58 marked this conversation as resolved

Aaron Carlisle requested review from Brecht Van Lommel 2023-05-25 04:43:29 +02:00

Raimund Klink added 1 commit 2023-05-25 08:23:49 +02:00

e5bac98c7d Incorporating the requested changes.

Rename from "Additional Cycles Arguments" to "Cycles Render Options".
Move above ' // printf("Experimental Features:\n");'

Raimund Klink added 1 commit 2023-05-25 08:49:32 +02:00

0a57ce2bd3 improve design

Raimund Klink requested review from Aaron Carlisle 2023-05-25 08:49:41 +02:00

Raimund Klink added 1 commit 2023-05-25 08:51:02 +02:00

de391383c6 less changes

Raimund Klink added 1 commit 2023-05-25 08:54:05 +02:00

fa8c863292 Change tripple space to \t\t

Raimund Klink changed title from ~~WIP: Docs: Make Cycles Args visible in the Docs~~ to Docs: Make Cycles Args visible in the Docs

2023-05-25 09:19:16 +02:00

Raimund Klink changed title from ~~Docs: Make Cycles Args visible in the Docs~~ to Docs: Make Cycles Args visible in --help

2023-05-25 14:13:05 +02:00

Brecht Van Lommel requested changes 2023-05-25 15:08:42 +02:00

source/creator/creator_args.c Outdated

						
				@ -637,0 +637,4 @@

				#  ifdef WITH_CYCLES

				  printf("Cycles Render Options:\n");

				  printf("\tIn addition to the options above, which apply to all render engines, ");

				  printf("\tCycles has additional options to further control its behavior.\n");

Brecht Van Lommel commented

2023-05-25 15:01:11 +02:00

These two lines seem unnecessary, the title covers it.

Raimund Klink commented

2023-05-25 15:54:19 +02:00

Done

Raimund58 marked this conversation as resolved

source/creator/creator_args.c Outdated

						
				@ -637,0 +639,4 @@

				  printf("\tIn addition to the options above, which apply to all render engines, ");

				  printf("\tCycles has additional options to further control its behavior.\n");

				  printf("\t# blender -b file.blend -f 20 -- --cycles-device CPU\n");

				  printf("\t.. note::\n");

Brecht Van Lommel commented

2023-05-25 14:50:43 +02:00

Don't use RST syntax here.

Raimund Klink commented

2023-05-25 16:01:46 +02:00

But how to make it look good in the manual as well?

Raimund58 marked this conversation as resolved

source/creator/creator_args.c Outdated

						
				@ -637,0 +640,4 @@

				  printf("\tCycles has additional options to further control its behavior.\n");

				  printf("\t# blender -b file.blend -f 20 -- --cycles-device CPU\n");

				  printf("\t.. note::\n");

				  printf("\t\tUnlike the generic options, the Cycles-specific ones must be passed on the end of the command line, following a double dash.\n");

Brecht Van Lommel commented

2023-05-25 15:08:22 +02:00

Cycles add-on options must be specified following a double dash.
# blender -b file.blend -f 1 -- --cycles-device CPU

``` Cycles add-on options must be specified following a double dash. # blender -b file.blend -f 1 -- --cycles-device CPU ```

Raimund58 marked this conversation as resolved

source/creator/creator_args.c Outdated

						
				@ -637,0 +642,4 @@

				  printf("\t.. note::\n");

				  printf("\t\tUnlike the generic options, the Cycles-specific ones must be passed on the end of the command line, following a double dash.\n");

				  printf("``--cycles-device CPU``\n");

				  printf("\tOverride the device that is used to render frames. Currently supported options are ``CPU``, ``CUDA``, ");

Brecht Van Lommel commented

2023-05-25 15:06:58 +02:00

Don't use backtick RST syntax here, and be more brief

Set the device used for rendering. Options: CPU, CUDA, OPTIX, HIP, ONEAPI, METAL
Append +CPU to a GPU device to render on both CPU and GPU.

Don't use backtick RST syntax here, and be more brief ``` Set the device used for rendering. Options: CPU, CUDA, OPTIX, HIP, ONEAPI, METAL Append +CPU to a GPU device to render on both CPU and GPU. ```

Raimund Klink commented

2023-05-25 15:58:27 +02:00

Hm, but how to make it look good in the manual as well if I can not use backticks?

Raimund58 marked this conversation as resolved

source/creator/creator_args.c

						
				@ -637,0 +645,4 @@

				  printf("\tOverride the device that is used to render frames. Currently supported options are ``CPU``, ``CUDA``, ");

				  printf("``OPTIX``, ``HIP``, ``ONEAPI``, and ``METAL``. Additionally, you can append ``+CPU`` to any GPU type for hybrid rendering.\n");

				  printf("``--cycles-print-stats``\n");

				  printf("\tShow detailed statistics about memory and time usage for Cycles renders on the console.\n");

Brecht Van Lommel commented

2023-05-25 15:04:04 +02:00

More brief:

Log statistics about render memory and time usage

More brief: ``` Log statistics about render memory and time usage ```

Raimund58 marked this conversation as resolved

Raimund Klink added 1 commit 2023-05-25 15:53:59 +02:00

ace89c7792 Incorporating the requested changes.

Raimund Klink added 1 commit 2023-05-25 15:56:59 +02:00

4a5b53c06b remove backticks

Raimund Klink added 1 commit 2023-05-25 16:01:09 +02:00

626adb4128 Change "note"

Raimund Klink requested review from Brecht Van Lommel 2023-05-25 16:03:13 +02:00

Raimund Klink added 1 commit 2023-05-25 16:27:05 +02:00

fcc44a439a remove backticks

Brecht Van Lommel requested changes 2023-05-25 16:36:16 +02:00

source/creator/creator_args.c Outdated

						
				@ -636,1 +636,4 @@

				#  ifdef WITH_CYCLES

				  printf("Cycles Render Options:\n");

				  printf("\tNote:\n");

Brecht Van Lommel commented

2023-05-25 16:36:10 +02:00

Remove this line, seems unnecessary.

Raimund58 marked this conversation as resolved

Raimund Klink added 1 commit 2023-05-25 16:44:43 +02:00

5d8f87a430 Incorporating the requested changes.

Trying to make it look good in the manual as well 
https://docs.blender.org/manual/en/3.6/advanced/command_line/arguments.html#other-options

Brecht Van Lommel approved these changes 2023-05-25 16:45:16 +02:00

Aaron Carlisle approved these changes 2023-05-26 04:46:17 +02:00

Aaron Carlisle merged commit 082766bfa4 into main

2023-05-27 00:53:11 +02:00

Aaron Carlisle referenced this issue from a commit

2023-05-27 00:53:12 +02:00

Docs: Make Cycles Args visible in --help

Aaron Carlisle referenced this issue from a commit

2023-05-28 01:38:29 +02:00

Move Cycles command line docs to command line page

Raimund Klink deleted branch raimund58-cycles-args

2023-05-28 08:22:58 +02:00

Howard Trickey referenced this issue from a commit

2023-05-29 02:51:36 +02:00

Merge in orign/main:

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Docs: Make Cycles Args visible in --help #108232