Updated documentation to fix Savannah bugs #32058 and #31582
[make.git] / remote-stub.c
blobe58b72cb624378dfd33e1cb178c4b70a3411160a
1 /* Template for the remote job exportation interface to GNU Make.
2 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
4 2010 Free Software Foundation, Inc.
5 This file is part of GNU Make.
7 GNU Make is free software; you can redistribute it and/or modify it under the
8 terms of the GNU General Public License as published by the Free Software
9 Foundation; either version 3 of the License, or (at your option) any later
10 version.
12 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License along with
17 this program. If not, see <http://www.gnu.org/licenses/>. */
19 #include "make.h"
20 #include "filedef.h"
21 #include "job.h"
22 #include "commands.h"
25 char *remote_description = 0;
27 /* Call once at startup even if no commands are run. */
29 void
30 remote_setup (void)
34 /* Called before exit. */
36 void
37 remote_cleanup (void)
41 /* Return nonzero if the next job should be done remotely. */
43 int
44 start_remote_job_p (int first_p UNUSED)
46 return 0;
49 /* Start a remote job running the command in ARGV,
50 with environment from ENVP. It gets standard input from STDIN_FD. On
51 failure, return nonzero. On success, return zero, and set *USED_STDIN
52 to nonzero if it will actually use STDIN_FD, zero if not, set *ID_PTR to
53 a unique identification, and set *IS_REMOTE to zero if the job is local,
54 nonzero if it is remote (meaning *ID_PTR is a process ID). */
56 int
57 start_remote_job (char **argv UNUSED, char **envp UNUSED, int stdin_fd UNUSED,
58 int *is_remote UNUSED, int *id_ptr UNUSED,
59 int *used_stdin UNUSED)
61 return -1;
64 /* Get the status of a dead remote child. Block waiting for one to die
65 if BLOCK is nonzero. Set *EXIT_CODE_PTR to the exit status, *SIGNAL_PTR
66 to the termination signal or zero if it exited normally, and *COREDUMP_PTR
67 nonzero if it dumped core. Return the ID of the child that died,
68 0 if we would have to block and !BLOCK, or < 0 if there were none. */
70 int
71 remote_status (int *exit_code_ptr UNUSED, int *signal_ptr UNUSED,
72 int *coredump_ptr UNUSED, int block UNUSED)
74 errno = ECHILD;
75 return -1;
78 /* Block asynchronous notification of remote child death.
79 If this notification is done by raising the child termination
80 signal, do not block that signal. */
81 void
82 block_remote_children (void)
84 return;
87 /* Restore asynchronous notification of remote child death.
88 If this is done by raising the child termination signal,
89 do not unblock that signal. */
90 void
91 unblock_remote_children (void)
93 return;
96 /* Send signal SIG to child ID. Return 0 if successful, -1 if not. */
97 int
98 remote_kill (int id UNUSED, int sig UNUSED)
100 return -1;