nortti
/
sortix-mirror
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix typos in doc/.

This commit is contained in:
Juhani Krekelä 2021-08-20 13:03:42 +03:00
parent 79799b0084
commit 777ed060c6
3 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/cross-compilation-sins
View File

@ -83,7 +83,7 @@ However, such tests are usually to detect broken systems. If testing is not
possible, then the build system should assume that the system is not broken. It possible, then the build system should assume that the system is not broken. It
is often just a single operating system that has such a problem and it may be is often just a single operating system that has such a problem and it may be
fixed in later releases. It is acceptable to inconvenience users of broken fixed in later releases. It is acceptable to inconvenience users of broken
operarating systems by asking them to pass an --using-broken-os configure option operating systems by asking them to pass an --using-broken-os configure option
or something similar, as long as it doesn't inconvenience honest users of good or something similar, as long as it doesn't inconvenience honest users of good
operating systems. operating systems.
@ -228,7 +228,7 @@ are usually similar enough, so it is simple to adapt a build system to use the
pkg-config variant exclusively instead. pkg-config variant exclusively instead.
The user can build a special cross-pkg-config or wrap an existing pkg-config by The user can build a special cross-pkg-config or wrap an existing pkg-config by
setting special environmental variables. There are some ceveats if the program setting special environmental variables. There are some caveats if the program
builds custom build tools that needs dependencies detected through pkg-config. builds custom build tools that needs dependencies detected through pkg-config.
In that case, the user may need to have a special pkg-config with a tool prefix In that case, the user may need to have a special pkg-config with a tool prefix
or pass a configure option setting the name of the build machine pkg-config or pass a configure option setting the name of the build machine pkg-config

14
doc/obsolete-stuff
View File

@ -83,7 +83,7 @@ standard interface is very poorly designed. In particular, if a process closes
a file descriptor, then all locks the process has for that file is unlocked, a file descriptor, then all locks the process has for that file is unlocked,
even though there might not be a lock associated with that file descriptor in even though there might not be a lock associated with that file descriptor in
the first place. This means that if the main program locks /foo/bar and runs the first place. This means that if the main program locks /foo/bar and runs
a library routine that also happen to open /foo/bar, then the advsisory lock set a library routine that also happen to open /foo/bar, then the advisory lock set
up by the main program is silently gone when when the library routine closes the up by the main program is silently gone when when the library routine closes the
file and returns to the main program. Additionally, the locks are attached to file and returns to the main program. Additionally, the locks are attached to
processes, rather than file descriptors. This complicates using them for threads processes, rather than file descriptors. This complicates using them for threads
@ -166,7 +166,7 @@ lockf
----- -----
This function implements POSIX advisory locks. It suffers from the same basic This function implements POSIX advisory locks. It suffers from the same basic
design mistakes that the fnctl advistory lock commands (F_GETLK, F_SETLK, design mistakes that the fnctl advisory lock commands (F_GETLK, F_SETLK,
F_SETLKW) do and should be avoided for the same reasons (see above). F_SETLKW) do and should be avoided for the same reasons (see above).
Use the flock (not to be confused with lockf) call instead as it works at a file Use the flock (not to be confused with lockf) call instead as it works at a file
@ -249,7 +249,7 @@ The fd_set system is poorly designed and the FD_SETSIZE is considerably smaller
than INT_MIN on most systems, which violates that the value of the file than INT_MIN on most systems, which violates that the value of the file
descriptor shouldn't matter as long as it is between 0 and INT_MAX. It would be descriptor shouldn't matter as long as it is between 0 and INT_MAX. It would be
better to use poll instead. There is also the problem that select uses struct better to use poll instead. There is also the problem that select uses struct
timeval instead of the superior struct timespec, though pselect solves tha timeval instead of the superior struct timespec, though pselect solves that
particular problem. particular problem.
Sortix currently provides this function for compatibility reasons. Sortix currently provides this function for compatibility reasons.
@ -261,8 +261,8 @@ The sprintf function is dangerous as it can be hard to predict the length of the
output string safely. A mistake can easily end in security vulnerabilities and output string safely. A mistake can easily end in security vulnerabilities and
undefined behavior. Use the snprintf function instead as it knows the size of undefined behavior. Use the snprintf function instead as it knows the size of
the destination buffer and safely truncates in the error case. Such truncation the destination buffer and safely truncates in the error case. Such truncation
can be detected by the cacller. Use the asprintf function or another approach can be detected by the caller. Use the asprintf function or another approach
if determinining the output length is hard. if determining the output length is hard.
Sortix currently provides this function for compatibility reasons. Sortix currently provides this function for compatibility reasons.
@ -288,7 +288,7 @@ sys/param.h
----------- -----------
This is a BSD header that contains a bunch of BSD-specific stuff and other This is a BSD header that contains a bunch of BSD-specific stuff and other
miscellaneous junk. The GNU libc implementation contains some uselese macros miscellaneous junk. The GNU libc implementation contains some useless macros
that doesn't justify its existence. The header inclusion can often be deleted that doesn't justify its existence. The header inclusion can often be deleted
without any problems, but older systems may require its inclusion. without any problems, but older systems may require its inclusion.
@ -315,7 +315,7 @@ This function is badly designed and the whole clock_t and sysconf(_SC_CLK_TCK)
business is insane. It doesn't help there is problem with potential overflowing business is insane. It doesn't help there is problem with potential overflowing
and the accuracy of the function varies between systems. You should avoid this and the accuracy of the function varies between systems. You should avoid this
function in favor of clock_gettime and the Sortix extension clocks that provide function in favor of clock_gettime and the Sortix extension clocks that provide
the same information as struct timespecs. If you need the atomic semantics of the same information as struct timespec. If you need the atomic semantics of
times, you can use the Sortix extension timens. times, you can use the Sortix extension timens.
Sortix currently provides this function for compatibility reasons. Sortix currently provides this function for compatibility reasons.

2
doc/porting-guide
View File

@ -454,7 +454,7 @@ archived source tix:
srctix-create libfoo.porttix.tar.xz srctix-create libfoo.porttix.tar.xz
This will create an suitabe `libfoo.srctix.tar.xz` in the current directory, This will create an suitable `libfoo.srctix.tar.xz` in the current directory,
which is an archive containing the normalized tree with all patches applied. which is an archive containing the normalized tree with all patches applied.
When reviewing, be sure to verify the included tarball in the archived port tix When reviewing, be sure to verify the included tarball in the archived port tix
is entirely identical to the upstream release byte-for-byte to avoid security is entirely identical to the upstream release byte-for-byte to avoid security