Bug 1807822 - nspr doc: remove some 'eval' r=kaie DONTBUILD

Differential Revision: https://phabricator.services.mozilla.com/D165625
This commit is contained in:
Sylvestre Ledru
2023-01-04 14:39:06 +00:00
parent 4b84cde0b6
commit cb275b5b7f
316 changed files with 343 additions and 343 deletions

View File

@@ -123,7 +123,7 @@ The tests were built above, in the ``pr/tests`` directory.
On Mac OS X, they can be executed with the following:
.. code:: eval
.. code::
/bin/sh:

View File

@@ -18,7 +18,7 @@ bottom layer using another network transport API. The poll method is one
of the functions in the PRIOMethods table. The prototype of the poll
method is
.. code:: eval
.. code::
PRInt16 poll_method(PRFileDesc *fd, PRInt16 in_flags, PRInt16 *out_flags);
@@ -95,21 +95,21 @@ method as follows.
Declare two PRInt16 variables to receive the return value and the
out_flags output argument of the poll method.
.. code:: eval
.. code::
PRInt16 new_flags, out_flags;
If you are going to call PR_Recv, pass PR_POLL_READ as the in_flags
argument.
.. code:: eval
.. code::
new_flags = fd->methods->poll(fd, PR_POLL_READ, &out_flags);
If you are going to call PR_Send, pass PR_POLL_WRITE as the in_flags
argument.
.. code:: eval
.. code::
new_flags = fd->methods->poll(fd, PR_POLL_WRITE, &out_flags);

View File

@@ -54,7 +54,7 @@ First protocol
**Server:**
.. code:: eval
.. code::
fm = PR_OpenAnonFileMap(dirName, size, FilemapProt);
addr = PR_MemMap(fm);
@@ -68,7 +68,7 @@ First protocol
**Client:**
.. code:: eval
.. code::
... started by server via PR_CreateProcess()
fm = PR_GetInheritedFileMap( shmname );
@@ -84,7 +84,7 @@ Second protocol
**Server:**
.. code:: eval
.. code::
fm = PR_OpenAnonFileMap(dirName, size, FilemapProt);
fmstring = PR_ExportFileMapAsString( fm );
@@ -96,7 +96,7 @@ Second protocol
**Client:**
.. code:: eval
.. code::
... started by server via his own magic
... application specific technique to find fmstring from parent

View File

@@ -42,7 +42,7 @@ executable program. (This is admittedly an omission that should be
fixed.) However, it is possible to look up symbols defined in the main
executable program as follows.
.. code:: eval
.. code::
PRLibrary *lib;
void *funcPtr;
@@ -94,7 +94,7 @@ list of directories specified by an environment variable.
``chatr`` tool. For example, link your executable program a.out
without the +s option, then execute the following:
.. code:: eval
.. code::
chatr +s enable a.out

View File

@@ -212,7 +212,7 @@ polymorphically.
NSPR defines three identities:
.. code:: eval
.. code::
#define PR_INVALID_IO_LAYER (PRDescIdentity)-1
#define PR_TOP_IO_LAYER (PRDescIdentity)-2

View File

@@ -298,7 +298,7 @@ within a monitor--the same monitor that protects the data being
manipulated by the notifier. In pseudocode, the sequence looks like
this:
.. code:: eval
.. code::
enter(monitor);
... manipulate the monitored data
@@ -311,7 +311,7 @@ design of the code that waits on a condition must take these facts into
account. Therefore, the pseudocode for the waiting thread might look
like this:
.. code:: eval
.. code::
enter(monitor)
while (!expression) wait(condition);
@@ -334,7 +334,7 @@ wait until there is an object available and that it should return a
reference to that object. Writing the code as follows could potentially
return a null reference, violating the invariant of the function:
.. code:: eval
.. code::
void *dequeue()
{
@@ -351,7 +351,7 @@ return a null reference, violating the invariant of the function:
The same function would be more appropriately written as follows:
.. code:: eval
.. code::
void *dequeue()
{

View File

@@ -93,7 +93,7 @@ debugging aids.
- Before running the compiled program, set the environment variable
NSPR_LOG_MODULES to userStuff:5
.. code:: eval
.. code::
static void UserLogStuff( void )
{

View File

@@ -37,7 +37,7 @@ Here are some simple examples of the use of these types:
In dowhim.h:
.. code:: eval
.. code::
PR_EXTERN( void ) DoWhatIMean( void );
@@ -47,7 +47,7 @@ Here are some simple examples of the use of these types:
In dowhim.c:
.. code:: eval
.. code::
PR_IMPLEMENT( void ) DoWhatIMean( void ) { return; };

View File

@@ -7,7 +7,7 @@ Compares two character strings.
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -7,7 +7,7 @@ Compares two ``void *`` values numerically.
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -7,7 +7,7 @@ A general-purpose hash function for character strings.
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -7,7 +7,7 @@ Add a new entry with the specified key and value to the hash table.
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -7,7 +7,7 @@ Frees the table and all the entries.
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -8,7 +8,7 @@ function on each entry.
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -7,7 +7,7 @@ Looks up the entry with the specified key and return its value.
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -7,7 +7,7 @@ Removes the entry with the specified key from the hash table.
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -7,7 +7,7 @@ Create a new hash table.
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -9,7 +9,7 @@ destination buffer.
Syntax
~~~~~~
.. code:: eval
.. code::
char * PL_strcpy(char *dest, const char *src);

View File

@@ -8,7 +8,7 @@ copy of a specified string.
Syntax
~~~~~~
.. code:: eval
.. code::
#include <plstr.h>

View File

@@ -7,7 +7,7 @@ Frees memory allocated by :ref:`PL_strdup`
Syntax
~~~~~~
.. code:: eval
.. code::
void PL_strfree(char *s);

View File

@@ -8,7 +8,7 @@ Returns the length of a specified string (not including the trailing
Syntax
~~~~~~
.. code:: eval
.. code::
PRUint32 PL_strlen(const char *str);

View File

@@ -2,7 +2,7 @@
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -5,7 +5,7 @@ PLHashComparator
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -2,7 +2,7 @@
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>
@@ -16,7 +16,7 @@ Description
table. An entry has a key and a value, represented by the following
fields in the ``PLHashEntry`` structure.
.. code:: eval
.. code::
const void *key;
void *value;

View File

@@ -2,7 +2,7 @@
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -2,7 +2,7 @@
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -2,7 +2,7 @@
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -2,7 +2,7 @@
Syntax
------
.. code:: eval
.. code::
#include <plhash.h>

View File

@@ -7,7 +7,7 @@ Aborts the process in a nongraceful manner.
Syntax
------
.. code:: eval
.. code::
#include <prinit.h>

View File

@@ -7,7 +7,7 @@ Accepts a connection on a specified socket.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -7,7 +7,7 @@ Accepts a new connection and receives a block of data.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -7,7 +7,7 @@ Determines the accessibility of a file.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -7,7 +7,7 @@ Appends an element to the end of a list.
Syntax
------
.. code:: eval
.. code::
#include <prclist.h>

View File

@@ -7,7 +7,7 @@ Terminates execution when a given expression is ``FALSE``.
Syntax
------
.. code:: eval
.. code::
#include <prlog.h>

View File

@@ -5,7 +5,7 @@ PR_AtomicAdd
Syntax
------
.. code:: eval
.. code::
#include <pratom.h>

View File

@@ -7,7 +7,7 @@ Atomically decrements a 32-bit value.
Syntax
------
.. code:: eval
.. code::
#include <pratom.h>

View File

@@ -7,7 +7,7 @@ Atomically increments a 32-bit value.
Syntax
------
.. code:: eval
.. code::
#include <pratom.h>

View File

@@ -7,7 +7,7 @@ Atomically sets a 32-bit value and return its previous contents.
Syntax
------
.. code:: eval
.. code::
#include <pratom.h>

View File

@@ -8,11 +8,11 @@ and maps it into the process memory space.
Syntax
------
.. code:: eval
.. code::
#include <prshm.h>
.. code:: eval
.. code::
NSPR_API( void * )
PR_AttachSharedMemory(

View File

@@ -14,7 +14,7 @@ Associates a :ref:`PRThread` object with an existing native thread.
Syntax
------
.. code:: eval
.. code::
#include <pprthread.h>

View File

@@ -9,7 +9,7 @@ specified file or socket.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -9,7 +9,7 @@ specified file or socket.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -7,7 +7,7 @@ Binds an address to a specified socket.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -7,7 +7,7 @@ Blocks the timer signal used for preemptive scheduling.
Syntax
------
.. code:: eval
.. code::
#include <prinit.h>

View File

@@ -8,7 +8,7 @@ client but called from a (different) shared library.
Syntax
------
.. code:: eval
.. code::
#include <prtypes.h>type PR_CALLBACKimplementation

View File

@@ -8,7 +8,7 @@ size.
Syntax
------
.. code:: eval
.. code::
#include <prmem.h>

View File

@@ -7,7 +7,7 @@ Ensures that subsystem initialization occurs only once.
Syntax
------
.. code:: eval
.. code::
PRStatus PR_CallOnce(
PRCallOnceType *once,

View File

@@ -7,7 +7,7 @@ Causes a previously queued job to be canceled.
Syntax
------
.. code:: eval
.. code::
#include <prtpool.h>

View File

@@ -7,7 +7,7 @@ Enters the lock associated with a cached monitor.
Syntax
------
.. code:: eval
.. code::
#include <prcmon.h>

View File

@@ -7,7 +7,7 @@ Decrement the entry count associated with a cached monitor.
Syntax
------
.. code:: eval
.. code::
#include <prcmon.h>

View File

@@ -7,7 +7,7 @@ Coordinates a graceful shutdown of NSPR.
Syntax
------
.. code:: eval
.. code::
#include <prinit.h>

View File

@@ -7,7 +7,7 @@ Clears the interrupt request for the calling thread.
Syntax
------
.. code:: eval
.. code::
#include <prthread.h>

View File

@@ -7,7 +7,7 @@ Checks for an empty circular list.
Syntax
------
.. code:: eval
.. code::
#include <prclist.h>

View File

@@ -7,7 +7,7 @@ Closes a file descriptor.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -7,7 +7,7 @@ Closes the specified directory.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -7,7 +7,7 @@ Closes a file mapping.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -7,7 +7,7 @@ Closes a specified semaphore.
Syntax
------
.. code:: eval
.. code::
#include <pripcsem.h>

View File

@@ -7,7 +7,7 @@ Closes a shared memory segment identified by name.
Syntax
------
.. code:: eval
.. code::
#include <prshm.h>

View File

@@ -7,7 +7,7 @@ Notify a thread waiting on a change in the state of monitored data.
Syntax
------
.. code:: eval
.. code::
#include <prcmon.h>

View File

@@ -8,7 +8,7 @@ data.
Syntax
------
.. code:: eval
.. code::
#include <prcmon.h>

View File

@@ -7,7 +7,7 @@ Converts a floating point number to a string.
Syntax
------
.. code:: eval
.. code::
#include <prdtoa.h>

View File

@@ -7,7 +7,7 @@ Initiates a connection on a specified socket.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -5,7 +5,7 @@ PR_ConnectContinue
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -7,7 +7,7 @@ Converts an IPv4 address into an (IPv4-mapped) IPv6 address.
Syntax
~~~~~~
.. code:: eval
.. code::
#include <prnetdb.h>

View File

@@ -7,7 +7,7 @@ Creates a file mapping object.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>
@@ -50,7 +50,7 @@ Description
The ``PRFileMapProtect`` enumeration used in the ``prot`` parameter is
defined as follows:
.. code:: eval
.. code::
typedef enum PRFileMapProtect {
PR_PROT_READONLY,

View File

@@ -7,7 +7,7 @@ Creates a new layer.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -8,7 +8,7 @@ and write ends of the pipe.
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -7,7 +7,7 @@ Creates a new thread.
Syntax
------
.. code:: eval
.. code::
#include <prthread.h>

View File

@@ -7,7 +7,7 @@ Create a new hash table.
Syntax
------
.. code:: eval
.. code::
#include <prtpool.h>

View File

@@ -7,7 +7,7 @@ Wait for a notification that a monitor's state has changed.
Syntax
------
.. code:: eval
.. code::
#include <prcmon.h>

View File

@@ -5,7 +5,7 @@ PR_Delete
Syntax
------
.. code:: eval
.. code::
#include <prio.h>

View File

@@ -8,7 +8,7 @@ Allocates memory of a specified size from the heap.
Syntax
------
.. code:: eval
.. code::
#include <prmem.h>

View File

@@ -7,7 +7,7 @@ Removes a semaphore specified by name from the system.
Syntax
------
.. code:: eval
.. code::
#include <pripcsem.h>

View File

@@ -7,7 +7,7 @@ Deletes a shared memory segment identified by name.
Syntax
------
.. code:: eval
.. code::
#include <prshm.h>

View File

@@ -7,7 +7,7 @@ Destroys a condition variable.
Syntax
------
.. code:: eval
.. code::
#include <prcvar.h>

View File

@@ -7,7 +7,7 @@ Destroys a specified lock object.
Syntax
------
.. code:: eval
.. code::
#include <prlock.h>

View File

@@ -7,7 +7,7 @@ Destroys a monitor object.
Syntax
------
.. code:: eval
.. code::
#include <prmon.h>

View File

@@ -8,7 +8,7 @@ related resources.
Syntax
------
.. code:: eval
.. code::
NSPR_API(PRStatus) PR_DestroyPollableEvent(PRFileDesc *event);

View File

@@ -7,7 +7,7 @@ Unmaps a shared memory segment identified by name.
Syntax
------
.. code:: eval
.. code::
#include <prshm.h>

View File

@@ -14,7 +14,7 @@ Disassociates a PRThread object from a native thread.
Syntax
------
.. code:: eval
.. code::
#include <pprthread.h>

View File

@@ -7,7 +7,7 @@ Disables timer signals used for preemptive scheduling.
Syntax
------
.. code:: eval
.. code::
#include <prinit.h>

View File

@@ -7,7 +7,7 @@ Converts a floating point number to a string.
Syntax
------
.. code:: eval
.. code::
#include <prdtoa.h>

View File

@@ -7,7 +7,7 @@ Enters the lock associated with a specified monitor.
Syntax
------
.. code:: eval
.. code::
#include <prmon.h>

View File

@@ -9,7 +9,7 @@ structure, acquired from :ref:`PR_GetAddrInfoByName`.
Syntax
~~~~~~
.. code:: eval
.. code::
#include <prnetdb.h>

View File

@@ -8,7 +8,7 @@ acquired from :ref:`PR_GetHostByName` or :ref:`PR_GetHostByAddr`.
Syntax
------
.. code:: eval
.. code::
#include <prnetdb.h>

View File

@@ -8,7 +8,7 @@ the entry count reaches zero, releases the monitor's lock.
Syntax
------
.. code:: eval
.. code::
#include <prmon.h>

View File

@@ -7,7 +7,7 @@ Converts an absolute time to a clock/calendar time.
Syntax
------
.. code:: eval
.. code::
#include <prtime.h>

View File

@@ -7,7 +7,7 @@ Creates a string identifying a :ref:`PRFileMap`.
Syntax
------
.. code:: eval
.. code::
#include <prshma.h>

View File

@@ -8,7 +8,7 @@ exported from a shared library.
Syntax
------
.. code:: eval
.. code::
#include <prtypes.h>

View File

@@ -7,7 +7,7 @@ Gets the value of the address family for Internet Protocol.
Syntax
------
.. code:: eval
.. code::
#include <prnetdb.h>

View File

@@ -9,7 +9,7 @@ representation of the symbol in question.
Syntax
------
.. code:: eval
.. code::
#include <prlink.h>

View File

@@ -8,7 +8,7 @@ both the symbol and the library in which it was found.
Syntax
------
.. code:: eval
.. code::
#include <prlink.h>

View File

@@ -7,7 +7,7 @@ Frees allocated memory in the heap.
Syntax
------
.. code:: eval
.. code::
#include <prmem.h>

View File

@@ -9,7 +9,7 @@ Destroys the ``PRAddrInfo`` structure returned by
Syntax
------
.. code:: eval
.. code::
#include <prnetdb.h>

View File

@@ -7,7 +7,7 @@ Conditionally frees allocated memory.
Syntax
------
.. code:: eval
.. code::
#include <prmem.h>

View File

@@ -7,7 +7,7 @@ Frees memory allocated by NSPR for library names and path names.
Syntax
------
.. code:: eval
.. code::
#include <prlink.h>

View File

@@ -8,7 +8,7 @@ of RFC 3493.
Syntax
------
.. code:: eval
.. code::
#include <prnetdb.h>

View File

@@ -8,7 +8,7 @@ Extracts the canonical name of the hostname passed to
Syntax
------
.. code:: eval
.. code::
#include <prnetdb.h>

View File

@@ -7,7 +7,7 @@ Get the completion status of a nonblocking connection.
Syntax
------
.. code:: eval
.. code::
PRStatus PR_GetConnectStatus(const PRPollDesc *pd);

View File

@@ -7,7 +7,7 @@ Returns the current thread object for the currently running code.
Syntax
------
.. code:: eval
.. code::
#include <prthread.h>

Some files were not shown because too many files have changed in this diff Show More