Skip to content

Commit b0268cb

Browse files
Doc updates
1 parent ea71ce1 commit b0268cb

5 files changed

Lines changed: 18 additions & 5 deletions

File tree

doc/acknowledgements.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ The first Boost.Process draft was created in 2006. A lof of people have worked o
44

55
The design of earlier versions of Boost.Process was not always satisfying. In 2011 Jeff Flinn proposed the executor and initializer concepts Boost.Process is based on today. Without Jeff's idea the overall design of Boost.Process would not look like it does today.
66

7-
A special thank you goes to [http://www.intra2net.com/(Intra2net AG) (especially Thomas Jarosch) who sponsored a project to support the development of Boost.Process. It was this sponsorship which made it possible to create a new Boost.Process version in 2012.
7+
A special thank you goes to http://www.intra2net.com[Intra2net AG] (especially Thomas Jarosch) who sponsored a project to support the development of Boost.Process. It was this sponsorship which made it possible to create a new Boost.Process version in 2012.
88

99
Great thanks also goes to Boris Schaeling, who despite having boost.process rejected, went on to work on it and maintained it up until this day and participated in the development of the current version.
1010

11-
Many Thanks, to [https://github.com/samuelvenable](Samuel Venable) for contributing the <<v2::ext>> functionality and all the research that went into it.
11+
Many Thanks to https://github.com/samuelvenable[Samuel Venable] for contributing the <<ext>> functionality and all the research that went into it.
1212

1313

doc/env.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[#env]
12
== Environment
23

34
The `environment` namespace provides all sorts of facilities to query and manipulate the environment of the current process.

doc/launcher.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ There are additional launcher available on most systems.
99
|Name | Summary | Default on | Available on
1010

1111

12-
13-
1412
|`windows::default_launcher` | `CreateProcessW` | windows |windows
1513
|`windows::as_user_launcher` | `CreateProcessAsUserW` | |windows
1614
|`windows::with_logon_launcher` | `CreateProcessWithLogonW` | |windows
@@ -120,7 +118,9 @@ struct custom_initializer
120118

121119
NOTE: All the additional launchers for windows inherit `default_launcher`.
122120

121+
WARNING: For security reasons, executing batch files is forbidden and needs to be explicitly enabled by setting `allow_batch_files` to `true`.
122+
123123
The call sequence is as follows:
124124

125125
image::windows_exec.svg
126-
'''
126+
'''

doc/stdio.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ E.g. a domain socket on linux.
5252
include::../example/stdio.cpp[tag=native_handle]
5353
----
5454

55+
[#stdio_popen]
5556
== popen
5657

5758
Additionally, process v2 provides a `popen` class.

doc/version2.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ The major changes are
1515
1616
Version 2 is now the default. In order to discourage usage of the deprecated v1, it's documentation has been removed.
1717

18+
The last version to include it was https://www.boost.org/doc/libs/1_87_0/doc/html/process.html[1.87].
19+
1820
== Simplified Interface
1921

2022
In process v1 one can define partial settings in the constructor of the process,
@@ -40,6 +42,9 @@ Furthermore, every process has a path and arguments, instead of a confusing mixt
4042
exe-args that can be randomly spread out.
4143

4244

45+
Likewise, the environvment is used explicitly as the second argument `find_executable`, which replaces `search_path`.
46+
47+
4348
== `pidfd_open`
4449

4550
Since process v1 came out, linux has moved along and added [pidfd_open](https://man7.org/linux/man-pages/man2/pidfd_open.2.html)
@@ -79,3 +84,9 @@ posix systems create a problem with inheriting file handles by default.
7984
Process V2 will automatically close all non-whitelisted descriptors,
8085
without needing any option to enable it.
8186

87+
88+
== Security issues
89+
90+
Batch files on windows are insecure because they can be
91+
https://learn.microsoft.com/en-us/security-updates/securitybulletins/2014/ms14-019[used for command injection].
92+

0 commit comments

Comments
 (0)