[education/kstars] doc: Fix minor typos
Git commit 323adaebb6b30b3b11428819a03dd1f5c92f0644 by Yuri Chornoivan. Committed on 30/11/2023 at 07:16. Pushed by yurchor into branch 'master'. Fix minor typos M +7-7doc/ekos-capture.docbook https://invent.kde.org/education/kstars/-/commit/323adaebb6b30b3b11428819a03dd1f5c92f0644 diff --git a/doc/ekos-capture.docbook b/doc/ekos-capture.docbook index bbbf7ba139..4237c7268c 100644 --- a/doc/ekos-capture.docbook +++ b/doc/ekos-capture.docbook @@ -510,7 +510,7 @@ The implementation of this process does not consider the strength (magnitude or flux) of the intended target, nor does it consider other factors which may cause an astrophotographer to choose a alternate sub-exposure time. These other factors may include: the storage requirements and extended post-processing time for a large number of short exposures, the impacts of external factors that might occur in very long exposures, such as tracking / guiding performance, changes in weather conditions which may disrupt seeing conditions, intrusions from air traffic or passing satellites. -Approaches to imaging can vary greatly in the selection of exposure times, and number of sub-exposures used for integration. A well accepted approach for imaging deep-sky objects utilizes long exposures, requires good guiding, good to excellent seeing conditions, and would typically employ filtering to reduce the effects of light polution. At the other extreme are approaches such as speckle imaging techniques (commonly 'lucky imaging'), which utilize many hundreds to many thousands of extremely short exposures in an attempt to eliminate the effects of light pollution, poor seeing conditions, and poor guiding. Choices made for values of certain inputs to the exposure calculator will vary depending upon which imaging approach is being employed. +Approaches to imaging can vary greatly in the selection of exposure times, and number of sub-exposures used for integration. A well accepted approach for imaging deep-sky objects utilizes long exposures, requires good guiding, good to excellent seeing conditions, and would typically employ filtering to reduce the effects of light pollution. At the other extreme are approaches such as speckle imaging techniques (commonly 'lucky imaging'), which utilize many hundreds to many thousands of extremely short exposures in an attempt to eliminate the effects of light pollution, poor seeing conditions, and poor guiding. Choices made for values of certain inputs to the exposure calculator will vary depending upon which imaging approach is being employed. @@ -522,10 +522,10 @@ Approaches to imaging can vary greatly in the selection of exposure times, and n The range for Sky Quality is from 22 for the darkest skies, to 16 for the brightest (most light-polluted) skies. The magnitude scale is non-linear; it is a logarithmic scale based on the 5th root of 100. So 5 steps on the scale represent a change in brightness by a factor of 100. (A Sky Quality of 17 is 100 times as bright as a Sky Quality of 22. Each full integer step on the scale is a change by a factor of approximately 2.512.). https://en.wikipedia.org/wiki/Light_pollution;>Wikipedia Sky Brightness https://en.wikipedia.org/wiki/Light_pollution;>Wikipedia Light Pollution - All light scattered in the backgound sky is considered to be light pollution regardless of its source, so the effects of moonlight should be considered as "natural" light pollution. But weather conditions can also impact Sky Quality, as humidity or cloud cover can reflect and scatter any source of light through the atmosphere + All light scattered in the background sky is considered to be light pollution regardless of its source, so the effects of moonlight should be considered as "natural" light pollution. But weather conditions can also impact Sky Quality, as humidity or cloud cover can reflect and scatter any source of light through the atmosphere A https://en.wikipedia.org/wiki/Sky_quality_meter;>Sky Quality Meter (SQM) - can provide the most accurate reading of sky quality if used during an imaging session, but an estimated value from sky quality surveys may also be found on the web at sites such as https://www.lightpollutionmap.info/;>www.lightpollutionmap.info or https://clearoutside.com/;>www.clearoutside.com. But these on-line sources for estimated light pollution genearrly do not account for the effects of moonlight or local weather conditions. So the values from light pollution web sites should only be considered as a “best case scenario” for a cloudless night during a new moon. + can provide the most accurate reading of sky quality if used during an imaging session,
[sdk/kdesrc-build] /: Delete the kdesrc-build-setup
Git commit 036f5092adc382e3cc0e4c5a4946b1dbcb10ec03 by Nate Graham, on behalf
of Andrew Shark.
Committed on 29/11/2023 at 17:32.
Pushed by ngraham into branch 'master'.
Delete the kdesrc-build-setup
This is duplicating the work of --generate-config. But it is mostly broken and
creates redundant source of "options defaults", see #132
Can I be made the maintainer of this project?
M +0-1CMakeLists.txt
M +5-20 README.md
M +0-1doc/CMakeLists.txt
M +1-1doc/README.md
M +0-1doc/build-docs
M +4-13 doc/index.docbook
D +0-204 doc/man-kdesrc-build-setup.1.docbook
M +0-2doc/man-kdesrc-build.1.docbook
D +0-615 kdesrc-build-setup
M +1-1sample-kde-env-master.sh
M +1-1sample-xsession.sh
https://invent.kde.org/sdk/kdesrc-build/-/commit/036f5092adc382e3cc0e4c5a4946b1dbcb10ec03
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 0e5869e2..789c34af 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -45,7 +45,6 @@ if (KDESRC_BUILD_INSTALL_MODULES)
endif()
install(PROGRAMS ${CMAKE_CURRENT_SOURCE_DIR}/kdesrc-build DESTINATION
${KDE_INSTALL_BINDIR})
-install(PROGRAMS ${CMAKE_CURRENT_SOURCE_DIR}/kdesrc-build-setup DESTINATION
${KDE_INSTALL_BINDIR})
install(PROGRAMS ${CMAKE_CURRENT_SOURCE_DIR}/kdesrc-run DESTINATION
${KDE_INSTALL_BINDIR})
install(PROGRAMS
diff --git a/README.md b/README.md
index 4b6fb180..6d938b1a 100644
--- a/README.md
+++ b/README.md
@@ -63,30 +63,15 @@ Later we will set up kdesrc-build to keep itself updated
automatically.
2. Set up kdesrc-build:
- Now that kdesrc-build is installed and works, you need to set up kdesrc-build
- to work appropriately on your particular system. Do this by running the
- provided set up script to generate the **configuration file**
- (~/.config/kdesrc-buildrc):
+ to work appropriately on your particular system.
```shell
$ cd ~/kde/src/kdesrc-build
-$ ./kdesrc-build-setup
-```
-
-- Answer the questions given, but do not fret if you don't know what exactly
- you want to build, it is easy to edit the configuration later or just to
- re-run `kdesrc-build-setup` again.
-
-- This script will reference a standard configuration provided as part of the
- kdesrc-build repository that you downloaded earlier. As kdesrc-build
- self-updates, these changes will reflect for your configuration as well.
-
-- After a configuration has been generated, kdesrc-build is able to bootstrap
- its environment on most distributions by running:
-```shell
$ ./kdesrc-build --initial-setup
```
- This will install the dependencies required by kdesrc-build as well as add
- itself to your path for convenience.
+
+- This will install the distribution packages dependencies required by
kdesrc-build,
+ generate a configuration file, and add itself to your path for convenience.
3. Download the KDE project and dependency data:
@@ -171,7 +156,7 @@ successfully upgraded kdesrc-build.
A sample configuration file is included for demonstration purposes. You could
copy it to `~/.config/kdesrc-buildrc` and edit manually. However,
-it is advised to use provided `kdesrc-build-setup` script instead.
+it is advised to use provided `kdesrc-build --generate-config` script instead.
## HELP!!!
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index d22b60a1..603d4b35 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -1,7 +1,6 @@
### install files ###
kdoctools_create_handbook(index.docbook INSTALL_DESTINATION
${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kdesrc-build)
kdoctools_create_manpage(man-kdesrc-build.1.docbook 1 INSTALL_DESTINATION
${MAN_INSTALL_DIR})
-kdoctools_create_manpage(man-kdesrc-build-setup.1.docbook 1
INSTALL_DESTINATION ${MAN_INSTALL_DIR})
install(PROGRAMS kdesrc-build.desktop DESTINATION ${KDE_INSTALL_APPDIR})
diff --git a/doc/README.md b/doc/README.md
index 984ab378..e6c60812 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -29,7 +29,7 @@ directory and generate multiple HTML files from the
index.docbook.
### Man page
There is also a man page, also authored in Docbook, at
-`man-kdesrc-build-setup.1.docbook` and `man-kdesrc-build.1.docbook`. These will
+`man-kdesrc-build.1.docbook`. It will
be built and installed to the KDE-specific `MANPATH` if you build kdesrc-build
with CMake. The content is mostly the same as in the normal DocBook docs but
can be more convenient at the command line, especially if Internet access is
diff --git a/doc/build-docs b/doc/build-docs
index 78616993..954a9661 100755
--- a/doc/build-docs
+++ b/doc/build-docs
@@ -100,4 +100,3 @@ STYLE=kde-chunk-online.xsl # the official one, used in
docs.kde.org website.
# render_docbook usage: $1 = docbook_file, $2 = folder for rendered html
files, $3 - stylesheet_file
render_docbook "index.docbook" "preview_doc_html" "$STYLE"
render_docbook "man-kdesrc-build.1.docbook" "preview_man_html" "$STYLE"
-#render_docbook "man-kdesrc-build-setup.1.docbook"
[sdk/kdesrc-build] doc: Add specification for configuration options
Git commit d9a2fb130cd9a096df5bc6ea182e36a66d814b9d by Andrew Shark. Committed on 29/11/2023 at 14:06. Pushed by ngraham into branch 'master'. Add specification for configuration options M +419 -258 doc/index.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/d9a2fb130cd9a096df5bc6ea182e36a66d814b9d diff --git a/doc/index.docbook b/doc/index.docbook index 6c4312ff..fe8b8248 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1759,53 +1759,67 @@ option. Global scope only options - + -Option-name -Module - Global Behavior -Notes +Option name +Description async -Cannot be overridden -This option enables the asynchronous mode of operation, where the source + + +TypeBoolean +Default valueTrue +Available since1.6 + +This option enables the asynchronous mode of operation, where the source code update and the build process will be performed in parallel, instead of waiting for -all of the source code updates before starting the build process. This option defaults -to enabling asynchronous mode. To disable, set this option to false -This option is available since the 1.6 release. +all of the source code updates before starting the build process. colorful-output -Cannot be overridden -Set this option to false to disable the colorful output of . -This option defaults to true. Note that will not output the + +TypeBoolean +Default valueTrue +Set this option to false to disable the colorful output of . +Note that will not output the color codes to anything but a terminal (such as xterm, , or the normal - console). + console). disable-agent-check -Cannot be overridden -Normally if you are using to download the sources -(such as if you are using the git+ssh protocol), will try and + + +TypeBoolean +Default valueFalse + +If you are using to download the sources +(such as if you are using the git+ssh protocol), this option controls if will try and make sure that if you are using ssh-agent, it is actually managing some identities. This is to try and prevent from asking for your pass phrase -for every module. You can disable this check by setting -disable-agent-check to true. +for every module. git-desired-protocol -Cannot be overridden -This option only applies to modules from a + +TypeString +Default valuegit +History informationThis option was added in 1.16. Prior to 20.06 this option +was used to configure the fetch URL instead of the push URL. As of 20.06 +https is always used when updating KDE projects. + +This option only applies to modules from a project repository. What this option actually does is configure which network protocol to @@ -1826,16 +1840,17 @@ needed for network traffic. In any other situation you should not set this option as the default protocol is most efficient. -This option was added in 1.16. Prior to 20.06 this option -was used to configure the fetch URL instead of the push URL. As of 20.06 -https is always used when updating KDE projects. git-repository-base -Cannot be overridden -This option, added in version 1.12.1, is used to create a short + + +TypeString +Available since1.12.1 + +This option is used to create a short name to reference a specific Git repository base URL in later module set declarations, which is useful for quickly declaring many Git modules to build. @@ -1844,26 +1859,21 @@ quickly declaring many Git modules to build. to the base URL, and the actual base URL itself. For example: - global -# other options - -# This is the common path to all anonymous Git server modules. -git-repository-base kde-git kde: +# other options +# This is the common path to all anonymous Git server modules. +git-repository-base kde-git kde: end global # Module declarations module-set -# Now you can use the alias you defined earlier, but only -# in a module-set. -repository kde-git - -use-modules module1.git module2.git +# Now you can use the alias you defined earlier, but only in a module-set. +repository kde-git +use-modules module1.git module2.git end module-set - The module-set's use-modules option created two modules @@ -1871,11 +1881,11 @@ internally, with behaving as if it had read: module module1 -repository kde:module1.git +repository kde:module1.git end module module module2 -repository kde:module2.git +repository kde:module2.git end module @@ -1895,8 +1905,12 @@ different module sets. ignore-modules -Can't be overridden -Modules named by this option, which would be chosen by + + +TypeString +Available since1.16 + +Modules named by this option, which would be chosen by due to a use-modules option, are instead skipped entirely. Use this option when you want to build an entire kde-projects project grouping @@ -1915,15 +1929,18 @@ result in both kde/kdegraphics/libs and is compared). See also . - -This option was introduced with 1.16. install-environment-driver -Cannot be overridden
