Merge #387

387: Errno: Format comments as docs r=stlankes a=mkroening



Co-authored-by: Martin Kröning <m.kroening@hotmail.de>
Co-authored-by: Stefan Lankes <stlankes@users.noreply.github.com>

src/errno.rs

-#![allow(dead_code)]
-
-pub const EPERM: i32 = 1; /* Operation not permitted */
-pub const ENOENT: i32 = 2; /* No such file or directory */
-pub const ESRCH: i32 = 3; /* No such process */
-pub const EINTR: i32 = 4; /* Interrupted system call */
-pub const EIO: i32 = 5; /* I/O error */
-pub const ENXIO: i32 = 6; /* No such device or address */
-pub const E2BIG: i32 = 7; /* Argument list too long */
-pub const ENOEXEC: i32 = 8; /* Exec format error */
-pub const EBADF: i32 = 9; /* Bad file number */
-pub const ECHILD: i32 = 10; /* No child processes */
-pub const EAGAIN: i32 = 11; /* Try again */
-pub const ENOMEM: i32 = 12; /* Out of memory */
-pub const EACCES: i32 = 13; /* Permission denied */
-pub const EFAULT: i32 = 14; /* Bad address */
-pub const ENOTBLK: i32 = 15; /* Block device required */
-pub const EBUSY: i32 = 16; /* Device or resource busy */
-pub const EEXIST: i32 = 17; /* File exists */
-pub const EXDEV: i32 = 18; /* Cross-device link */
-pub const ENODEV: i32 = 19; /* No such device */
-pub const ENOTDIR: i32 = 20; /* Not a directory */
-pub const EISDIR: i32 = 21; /* Is a directory */
-pub const EINVAL: i32 = 22; /* Invalid argument */
-pub const ENFILE: i32 = 23; /* File table overflow */
-pub const EMFILE: i32 = 24; /* Too many open files */
-pub const ENOTTY: i32 = 25; /* Not a typewriter */
-pub const ETXTBSY: i32 = 26; /* Text file busy */
-pub const EFBIG: i32 = 27; /* File too large */
-pub const ENOSPC: i32 = 28; /* No space left on device */
-pub const ESPIPE: i32 = 29; /* Illegal seek */
-pub const EROFS: i32 = 30; /* Read-only file system */
-pub const EMLINK: i32 = 31; /* Too many links */
-pub const EPIPE: i32 = 32; /* Broken pipe */
-pub const EDOM: i32 = 33; /* Math argument out of domain of func */
-pub const ERANGE: i32 = 34; /* Math result not representable */
-pub const EDEADLK: i32 = 35; /* Resource deadlock would occur */
-pub const ENAMETOOLONG: i32 = 36; /* File name too long */
-pub const ENOLCK: i32 = 37; /* No record locks available */
-pub const ENOSYS: i32 = 38; /* Function not implemented */
-pub const ENOTEMPTY: i32 = 39; /* Directory not empty */
-pub const ELOOP: i32 = 40; /* Too many symbolic links encountered */
-pub const EWOULDBLOCK: i32 = EAGAIN; /* Operation would block */
-pub const ENOMSG: i32 = 42; /* No message of desired type */
-pub const EIDRM: i32 = 43; /* Identifier removed */
-pub const ECHRNG: i32 = 44; /* Channel number out of range */
-pub const EL2NSYNC: i32 = 45; /* Level 2 not synchronized */
-pub const EL3HLT: i32 = 46; /* Level 3 halted */
-pub const EL3RST: i32 = 47; /* Level 3 reset */
-pub const ELNRNG: i32 = 48; /* Link number out of range */
-pub const EUNATCH: i32 = 49; /* Protocol driver not attached */
-pub const ENOCSI: i32 = 50; /* No CSI structure available */
-pub const EL2HLT: i32 = 51; /* Level 2 halted */
-pub const EBADE: i32 = 52; /* Invalid exchange */
-pub const EBADR: i32 = 53; /* Invalid request descriptor */
-pub const EXFULL: i32 = 54; /* Exchange full */
-pub const ENOANO: i32 = 55; /* No anode */
-pub const EBADRQC: i32 = 56; /* Invalid request code */
-pub const EBADSLT: i32 = 57; /* Invalid slot */
+/// Operation not permitted
+pub const EPERM: i32 = 1;
+
+/// No such file or directory
+pub const ENOENT: i32 = 2;
+
+/// No such process
+pub const ESRCH: i32 = 3;
+
+/// Interrupted system call
+pub const EINTR: i32 = 4;
+
+/// I/O error
+pub const EIO: i32 = 5;
+
+/// No such device or address
+pub const ENXIO: i32 = 6;
+
+/// Argument list too long
+pub const E2BIG: i32 = 7;
+
+/// Exec format error
+pub const ENOEXEC: i32 = 8;
+
+/// Bad file number
+pub const EBADF: i32 = 9;
+
+/// No child processes
+pub const ECHILD: i32 = 10;
+
+/// Try again
+pub const EAGAIN: i32 = 11;
+
+/// Out of memory
+pub const ENOMEM: i32 = 12;
+
+/// Permission denied
+pub const EACCES: i32 = 13;
+
+/// Bad address
+pub const EFAULT: i32 = 14;
+
+/// Block device required
+pub const ENOTBLK: i32 = 15;
+
+/// Device or resource busy
+pub const EBUSY: i32 = 16;
+
+/// File exists
+pub const EEXIST: i32 = 17;
+
+/// Cross-device link
+pub const EXDEV: i32 = 18;
+
+/// No such device
+pub const ENODEV: i32 = 19;
+
+/// Not a directory
+pub const ENOTDIR: i32 = 20;
+
+/// Is a directory
+pub const EISDIR: i32 = 21;
+
+/// Invalid argument
+pub const EINVAL: i32 = 22;
+
+/// File table overflow
+pub const ENFILE: i32 = 23;
+
+/// Too many open files
+pub const EMFILE: i32 = 24;
+
+/// Not a typewriter
+pub const ENOTTY: i32 = 25;
+
+/// Text file busy
+pub const ETXTBSY: i32 = 26;
+
+/// File too large
+pub const EFBIG: i32 = 27;
+
+/// No space left on device
+pub const ENOSPC: i32 = 28;
+
+/// Illegal seek
+pub const ESPIPE: i32 = 29;
+
+/// Read-only file system
+pub const EROFS: i32 = 30;
+
+/// Too many links
+pub const EMLINK: i32 = 31;
+
+/// Broken pipe
+pub const EPIPE: i32 = 32;
+
+/// Math argument out of domain of func
+pub const EDOM: i32 = 33;
+
+/// Math result not representable
+pub const ERANGE: i32 = 34;
+
+/// Resource deadlock would occur
+pub const EDEADLK: i32 = 35;
+
+/// File name too long
+pub const ENAMETOOLONG: i32 = 36;
+
+/// No record locks available
+pub const ENOLCK: i32 = 37;
+
+/// Function not implemented
+pub const ENOSYS: i32 = 38;
+
+/// Directory not empty
+pub const ENOTEMPTY: i32 = 39;
+
+/// Too many symbolic links encountered
+pub const ELOOP: i32 = 40;
+
+/// Operation would block
+pub const EWOULDBLOCK: i32 = EAGAIN;
+
+/// No message of desired type
+pub const ENOMSG: i32 = 42;
+
+/// Identifier removed
+pub const EIDRM: i32 = 43;
+
+/// Channel number out of range
+pub const ECHRNG: i32 = 44;
+
+/// Level 2 not synchronized
+pub const EL2NSYNC: i32 = 45;
+
+/// Level 3 halted
+pub const EL3HLT: i32 = 46;
+
+/// Level 3 reset
+pub const EL3RST: i32 = 47;
+
+/// Link number out of range
+pub const ELNRNG: i32 = 48;
+
+/// Protocol driver not attached
+pub const EUNATCH: i32 = 49;
+
+/// No CSI structure available
+pub const ENOCSI: i32 = 50;
+
+/// Level 2 halted
+pub const EL2HLT: i32 = 51;
+
+/// Invalid exchange
+pub const EBADE: i32 = 52;
+
+/// Invalid request descriptor
+pub const EBADR: i32 = 53;
+
+/// Exchange full
+pub const EXFULL: i32 = 54;
+
+/// No anode
+pub const ENOANO: i32 = 55;
+
+/// Invalid request code
+pub const EBADRQC: i32 = 56;
+
+/// Invalid slot
+pub const EBADSLT: i32 = 57;
+
 pub const EDEADLOCK: i32 = EDEADLK;
-pub const EBFONT: i32 = 59; /* Bad font file format */
-pub const ENOSTR: i32 = 60; /* Device not a stream */
-pub const ENODATA: i32 = 61; /* No data available */
-pub const ETIME: i32 = 62; /* Timer expired */
-pub const ENOSR: i32 = 63; /* Out of streams resources */
-pub const ENONET: i32 = 64; /* Machine is not on the network */
-pub const ENOPKG: i32 = 65; /* Package not installed */
-pub const EREMOTE: i32 = 66; /* Object is remote */
-pub const ENOLINK: i32 = 67; /* Link has been severed */
-pub const EADV: i32 = 68; /* Advertise error */
-pub const ESRMNT: i32 = 69; /* Srmount error */
-pub const ECOMM: i32 = 70; /* Communication error on send */
-pub const EPROTO: i32 = 71; /* Protocol error */
-pub const EMULTIHOP: i32 = 72; /* Multihop attempted */
-pub const EDOTDOT: i32 = 73; /* RFS specific error */
-pub const EBADMSG: i32 = 74; /* Not a data message */
-pub const EOVERFLOW: i32 = 75; /* Value too large for defined data type */
-pub const ENOTUNIQ: i32 = 76; /* Name not unique on network */
-pub const EBADFD: i32 = 77; /* File descriptor in bad state */
-pub const EREMCHG: i32 = 78; /* Remote address changed */
-pub const ELIBACC: i32 = 79; /* Can not access a needed shared library */
-pub const ELIBBAD: i32 = 80; /* Accessing a corrupted shared library */
-pub const ELIBSCN: i32 = 81; /* .lib section in a.out corrupted */
-pub const ELIBMAX: i32 = 82; /* Attempting to link in too many shared libraries */
-pub const ELIBEXEC: i32 = 83; /* Cannot exec a shared library directly */
-pub const EILSEQ: i32 = 84; /* Illegal byte sequence */
-pub const ERESTART: i32 = 85; /* Interrupted system call should be restarted */
-pub const ESTRPIPE: i32 = 86; /* Streams pipe error */
-pub const EUSERS: i32 = 87; /* Too many users */
-pub const ENOTSOCK: i32 = 88; /* Socket operation on non-socket */
-pub const EDESTADDRREQ: i32 = 89; /* Destination address required */
-pub const EMSGSIZE: i32 = 90; /* Message too long */
-pub const EPROTOTYPE: i32 = 91; /* Protocol wrong type for socket */
-pub const ENOPROTOOPT: i32 = 92; /* Protocol not available */
-pub const EPROTONOSUPPORT: i32 = 93; /* Protocol not supported */
-pub const ESOCKTNOSUPPORT: i32 = 94; /* Socket type not supported */
-pub const EOPNOTSUPP: i32 = 95; /* Operation not supported on transport endpoint */
-pub const EPFNOSUPPORT: i32 = 96; /* Protocol family not supported */
-pub const EAFNOSUPPORT: i32 = 97; /* Address family not supported by protocol */
-pub const EADDRINUSE: i32 = 98; /* Address already in use */
-pub const EADDRNOTAVAIL: i32 = 99; /* Cannot assign requested address */
-pub const ENETDOWN: i32 = 100; /* Network is down */
-pub const ENETUNREACH: i32 = 101; /* Network is unreachable */
-pub const ENETRESET: i32 = 102; /* Network dropped connection because of reset */
-pub const ECONNABORTED: i32 = 103; /* Software caused connection abort */
-pub const ECONNRESET: i32 = 104; /* Connection reset by peer */
-pub const ENOBUFS: i32 = 105; /* No buffer space available */
-pub const EISCONN: i32 = 106; /* Transport endpoint is already connected */
-pub const ENOTCONN: i32 = 107; /* Transport endpoint is not connected */
-pub const ESHUTDOWN: i32 = 108; /* Cannot send after transport endpoint shutdown */
-pub const ETOOMANYREFS: i32 = 109; /* Too many references: cannot splice */
-pub const ETIMEDOUT: i32 = 110; /* Connection timed out */
-pub const ECONNREFUSED: i32 = 111; /* Connection refused */
-pub const EHOSTDOWN: i32 = 112; /* Host is down */
-pub const EHOSTUNREACH: i32 = 113; /* No route to host */
-pub const EALREADY: i32 = 114; /* Operation already in progress */
-pub const EINPROGRESS: i32 = 115; /* Operation now in progress */
-pub const ESTALE: i32 = 116; /* Stale file handle */
-pub const EUCLEAN: i32 = 117; /* Structure needs cleaning */
-pub const ENOTNAM: i32 = 118; /* Not a XENIX named type file */
-pub const ENAVAIL: i32 = 119; /* No XENIX semaphores available */
-pub const EISNAM: i32 = 120; /* Is a named type file */
-pub const EREMOTEIO: i32 = 121; /* Remote I/O error */
-pub const EDQUOT: i32 = 122; /* Quota exceeded */
-pub const ENOMEDIUM: i32 = 123; /* No medium found */
-pub const EMEDIUMTYPE: i32 = 124; /* Wrong medium type */
-pub const ECANCELED: i32 = 125; /* Operation Canceled */
-pub const ENOKEY: i32 = 126; /* Required key not available */
-pub const EKEYEXPIRED: i32 = 127; /* Key has expired */
-pub const EKEYREVOKED: i32 = 128; /* Key has been revoked */
-pub const EKEYREJECTED: i32 = 129; /* Key was rejected by service */
-
-/* for robust mutexes */
-pub const EOWNERDEAD: i32 = 130; /* Owner died */
-pub const ENOTRECOVERABLE: i32 = 131; /* State not recoverable */
-
-pub const ERFKILL: i32 = 132; /* Operation not possible due to RF-kill */
-
-pub const EHWPOISON: i32 = 133; /* Memory page has hardware error */
+
+/// Bad font file format
+pub const EBFONT: i32 = 59;
+
+/// Device not a stream
+pub const ENOSTR: i32 = 60;
+
+/// No data available
+pub const ENODATA: i32 = 61;
+
+/// Timer expired
+pub const ETIME: i32 = 62;
+
+/// Out of streams resources
+pub const ENOSR: i32 = 63;
+
+/// Machine is not on the network
+pub const ENONET: i32 = 64;
+
+/// Package not installed
+pub const ENOPKG: i32 = 65;
+
+/// Object is remote
+pub const EREMOTE: i32 = 66;
+
+/// Link has been severed
+pub const ENOLINK: i32 = 67;
+
+/// Advertise error
+pub const EADV: i32 = 68;
+
+/// Srmount error
+pub const ESRMNT: i32 = 69;
+
+/// Communication error on send
+pub const ECOMM: i32 = 70;
+
+/// Protocol error
+pub const EPROTO: i32 = 71;
+
+/// Multihop attempted
+pub const EMULTIHOP: i32 = 72;
+
+/// RFS specific error
+pub const EDOTDOT: i32 = 73;
+
+/// Not a data message
+pub const EBADMSG: i32 = 74;
+
+/// Value too large for defined data type
+pub const EOVERFLOW: i32 = 75;
+
+/// Name not unique on network
+pub const ENOTUNIQ: i32 = 76;
+
+/// File descriptor in bad state
+pub const EBADFD: i32 = 77;
+
+/// Remote address changed
+pub const EREMCHG: i32 = 78;
+
+/// Can not access a needed shared library
+pub const ELIBACC: i32 = 79;
+
+/// Accessing a corrupted shared library
+pub const ELIBBAD: i32 = 80;
+
+/// .lib section in a.out corrupted
+pub const ELIBSCN: i32 = 81;
+
+/// Attempting to link in too many shared libraries
+pub const ELIBMAX: i32 = 82;
+
+/// Cannot exec a shared library directly
+pub const ELIBEXEC: i32 = 83;
+
+/// Illegal byte sequence
+pub const EILSEQ: i32 = 84;
+
+/// Interrupted system call should be restarted
+pub const ERESTART: i32 = 85;
+
+/// Streams pipe error
+pub const ESTRPIPE: i32 = 86;
+
+/// Too many users
+pub const EUSERS: i32 = 87;
+
+/// Socket operation on non-socket
+pub const ENOTSOCK: i32 = 88;
+
+/// Destination address required
+pub const EDESTADDRREQ: i32 = 89;
+
+/// Message too long
+pub const EMSGSIZE: i32 = 90;
+
+/// Protocol wrong type for socket
+pub const EPROTOTYPE: i32 = 91;
+
+/// Protocol not available
+pub const ENOPROTOOPT: i32 = 92;
+
+/// Protocol not supported
+pub const EPROTONOSUPPORT: i32 = 93;
+
+/// Socket type not supported
+pub const ESOCKTNOSUPPORT: i32 = 94;
+
+/// Operation not supported on transport endpoint
+pub const EOPNOTSUPP: i32 = 95;
+
+/// Protocol family not supported
+pub const EPFNOSUPPORT: i32 = 96;
+
+/// Address family not supported by protocol
+pub const EAFNOSUPPORT: i32 = 97;
+
+/// Address already in use
+pub const EADDRINUSE: i32 = 98;
+
+/// Cannot assign requested address
+pub const EADDRNOTAVAIL: i32 = 99;
+
+/// Network is down
+pub const ENETDOWN: i32 = 100;
+
+/// Network is unreachable
+pub const ENETUNREACH: i32 = 101;
+
+/// Network dropped connection because of reset
+pub const ENETRESET: i32 = 102;
+
+/// Software caused connection abort
+pub const ECONNABORTED: i32 = 103;
+
+/// Connection reset by peer
+pub const ECONNRESET: i32 = 104;
+
+/// No buffer space available
+pub const ENOBUFS: i32 = 105;
+
+/// Transport endpoint is already connected
+pub const EISCONN: i32 = 106;
+
+/// Transport endpoint is not connected
+pub const ENOTCONN: i32 = 107;
+
+/// Cannot send after transport endpoint shutdown
+pub const ESHUTDOWN: i32 = 108;
+
+/// Too many references: cannot splice
+pub const ETOOMANYREFS: i32 = 109;
+
+/// Connection timed out
+pub const ETIMEDOUT: i32 = 110;
+
+/// Connection refused
+pub const ECONNREFUSED: i32 = 111;
+
+/// Host is down
+pub const EHOSTDOWN: i32 = 112;
+
+/// No route to host
+pub const EHOSTUNREACH: i32 = 113;
+
+/// Operation already in progress
+pub const EALREADY: i32 = 114;
+
+/// Operation now in progress
+pub const EINPROGRESS: i32 = 115;
+
+/// Stale file handle
+pub const ESTALE: i32 = 116;
+
+/// Structure needs cleaning
+pub const EUCLEAN: i32 = 117;
+
+/// Not a XENIX named type file
+pub const ENOTNAM: i32 = 118;
+
+/// No XENIX semaphores available
+pub const ENAVAIL: i32 = 119;
+
+/// Is a named type file
+pub const EISNAM: i32 = 120;
+
+/// Remote I/O error
+pub const EREMOTEIO: i32 = 121;
+
+/// Quota exceeded
+pub const EDQUOT: i32 = 122;
+
+/// No medium found
+pub const ENOMEDIUM: i32 = 123;
+
+/// Wrong medium type
+pub const EMEDIUMTYPE: i32 = 124;
+
+/// Operation Canceled
+pub const ECANCELED: i32 = 125;
+
+/// Required key not available
+pub const ENOKEY: i32 = 126;
+
+/// Key has expired
+pub const EKEYEXPIRED: i32 = 127;
+
+/// Key has been revoked
+pub const EKEYREVOKED: i32 = 128;
+
+/// Key was rejected by service
+pub const EKEYREJECTED: i32 = 129;
+
+/// Robust mutexes: Owner died
+pub const EOWNERDEAD: i32 = 130;
+
+/// Robust mutexes: State not recoverable
+pub const ENOTRECOVERABLE: i32 = 131;
+
+/// Robust mutexes: Operation not possible due to RF-kill
+pub const ERFKILL: i32 = 132;
+
+/// Robust mutexes: Memory page has hardware error
+pub const EHWPOISON: i32 = 133;