README.md
author Jan Vrany <jan.vrany@fit.cvut.cz>
Tue, 18 Jun 2019 11:04:46 +0100
changeset 193 2aa0074479d9
parent 161 4e020e46a29c
child 216 800057dbad30
permissions -rw-r--r--
Add (utility) `GDBProcess >> gdbCommandParseAndValidate:` to parse and validate given GDB command. This is used both by `GDBLocalProcess` and settings UI.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
139
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     1
# libgdbs
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     2
152
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
     3
*libgdbs* is a library providing smalltalk interface for GDB.
139
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     4
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     5
## Features
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     6
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     7
 * event-based interface
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     8
 * convenient API to inspect and query current state of a debugee
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
     9
 * support for custom disassembler allowing for custom code analysis
152
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    10
139
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    11
## Building from Source
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    12
152
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    13
*libgsbs* is a part of [Smalltalk/X jv-branch][3] since version 8.0.0. To
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    14
build *libgsbs*, just follow instructions how to [build
139
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    15
Smalltalk/X jv-branch][6]
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    16
152
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    17
## Prerequisites
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    18
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    19
As of today, *libgdbs* requires a very recent GDB. Likely you'd need to
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    20
compile a GDB yourself - see [GDB.md][9]
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    21
161
4e020e46a29c Added some documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 152
diff changeset
    22
## Documentation
4e020e46a29c Added some documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 152
diff changeset
    23
4e020e46a29c Added some documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 152
diff changeset
    24
Some documentation can be found in [doc][10] directory, see [doc/README.md][10]
4e020e46a29c Added some documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 152
diff changeset
    25
139
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    26
## Reporting issues
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    27
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    28
Use [Smalltalk/X jv-branch issue tracker][6] to [report issues][7] (you may need
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    29
to login using your Google account in order to submit an issue). Alternatively,
152
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    30
send a message to [Smalltalk/X mailing list][8].
139
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    31
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    32
## Author
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    33
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    34
Jan Vrany `<jan.vrany [at] fit.cvut.cz>`
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    35
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    36
## License
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    37
152
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    38
This software is licensed under *GNU LESSER GENERAL PUBLIC LICENSE Version 2.1*.
139
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    39
You may find a full license text in `LICENSE.txt`.
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    40
152
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    41
For permissions beyond the scope of this license please contact author at
139
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    42
`<jan.vrany [at] fit.cvut.cz>`
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    43
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    44
[2]: https://www.gnu.org/software/gdb/
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    45
[3]: https://swing.fit.cvut.cz/projects/stx-jv
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    46
[4]: https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    47
[5]: https://swing.fit.cvut.cz/jenkins/job/stx_jv/lastSuccessfulBuild/
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    48
[6]: https://swing.fit.cvut.cz/projects/stx-jv/report/9
6e2f0594a5c5 Add `READNE.md`
Jan Vrany <jan.vrany@fit.cvut.cz>
parents:
diff changeset
    49
[7]: https://swing.fit.cvut.cz/projects/stx-jv/newticket
152
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    50
[8]: https://groups.google.com/forum/#!forum/stx-jv
fab425b52c21 Refactor `GDBProcess` hierarchy to improve portability
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 139
diff changeset
    51
[9]: doc/GDB.md
161
4e020e46a29c Added some documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 152
diff changeset
    52
[10]: doc/README.md