| Message ID | 20170815093615.16453-2-berrange@redhat.com |
|---|---|
| State | New |
| Headers | show |
On Tue, Aug 15, 2017 at 10:36:04AM +0100, Daniel P. Berrange wrote: > The https://gitlab.com/keycodemap/keycodemapdb/ repo contains a > data file mapping between all the different scancode/keycode/keysym > sets that are known, and a tool to auto-generate lookup tables for > different combinations. > > It is used by GTK-VNC, SPICE-GTK and libvirt for mapping keys. > Using it in QEMU will let us replace many hand written lookup > tables with auto-generated tables from a master data source, > reducing bugs. Adding new QKeyCodes will now only require the > master table to be updated, all ~20 other tables will be > automatically updated to follow. > > Signed-off-by: Daniel P. Berrange <berrange@redhat.com> > --- > .gitignore | 2 ++ > .gitmodules | 3 +++ > configure | 2 ++ > tests/docker/Makefile.include | 11 +++++++---- > tests/docker/run | 4 +++- > ui/Makefile.objs | 18 ++++++++++++++++++ > ui/keycodemapdb | 1 + > 7 files changed, 36 insertions(+), 5 deletions(-) > create mode 160000 ui/keycodemapdb > > diff --git a/configure b/configure > index dd73cce62f..bd373ec2b4 100755 > --- a/configure > +++ b/configure > @@ -5258,6 +5258,8 @@ echo_version() { > fi > } > > +(cd $source_path && git submodule update --init ui/keycodemapdb) > + Urgh, no, this won't work because of course you don't have to have a git checkout when running configure. Any suggestions on the "best" way to ensure that the ui/keycodemapdb git submodule is always checked out, without requiring developers to do something manually ? I could try (cd $source_path && test -d .git && git submodule update --init ui/keycodemapdb) but wonder if there's a better way ? Regards, Daniel
On Tue, 08/15 11:04, Daniel P. Berrange wrote: > On Tue, Aug 15, 2017 at 10:36:04AM +0100, Daniel P. Berrange wrote: > > The https://gitlab.com/keycodemap/keycodemapdb/ repo contains a > > data file mapping between all the different scancode/keycode/keysym > > sets that are known, and a tool to auto-generate lookup tables for > > different combinations. > > > > It is used by GTK-VNC, SPICE-GTK and libvirt for mapping keys. > > Using it in QEMU will let us replace many hand written lookup > > tables with auto-generated tables from a master data source, > > reducing bugs. Adding new QKeyCodes will now only require the > > master table to be updated, all ~20 other tables will be > > automatically updated to follow. > > > > Signed-off-by: Daniel P. Berrange <berrange@redhat.com> > > --- > > .gitignore | 2 ++ > > .gitmodules | 3 +++ > > configure | 2 ++ > > tests/docker/Makefile.include | 11 +++++++---- > > tests/docker/run | 4 +++- > > ui/Makefile.objs | 18 ++++++++++++++++++ > > ui/keycodemapdb | 1 + > > 7 files changed, 36 insertions(+), 5 deletions(-) > > create mode 160000 ui/keycodemapdb > > > > > diff --git a/configure b/configure > > index dd73cce62f..bd373ec2b4 100755 > > --- a/configure > > +++ b/configure > > @@ -5258,6 +5258,8 @@ echo_version() { > > fi > > } > > > > +(cd $source_path && git submodule update --init ui/keycodemapdb) > > + > > Urgh, no, this won't work because of course you don't have to > have a git checkout when running configure. > > Any suggestions on the "best" way to ensure that the ui/keycodemapdb > git submodule is always checked out, without requiring developers to > do something manually ? > > I could try > > (cd $source_path && test -d .git && git submodule update --init ui/keycodemapdb) > > but wonder if there's a better way ? I think the way dtc handles this is okay: probe headers/libs, if failed, hint the "git submodule update" command in the error message. This is also a familiar/friendly user interface to developers. (If you looks at the test snippet that patchew runs, there is an explicit submodule command: #!/bin/bash set -e git submodule update --init dtc # Let docker tests dump environment info export SHOW_ENV=1 export J=8 time make docker-test-quick@centos6 time make docker-test-build@min-glib time make docker-test-mingw@fedora as the libfdt devel package is not available in every docker images.) Fam
On Tue, Aug 15, 2017 at 06:47:22PM +0800, Fam Zheng wrote: > On Tue, 08/15 11:04, Daniel P. Berrange wrote: > > On Tue, Aug 15, 2017 at 10:36:04AM +0100, Daniel P. Berrange wrote: > > > The https://gitlab.com/keycodemap/keycodemapdb/ repo contains a > > > data file mapping between all the different scancode/keycode/keysym > > > sets that are known, and a tool to auto-generate lookup tables for > > > different combinations. > > > > > > It is used by GTK-VNC, SPICE-GTK and libvirt for mapping keys. > > > Using it in QEMU will let us replace many hand written lookup > > > tables with auto-generated tables from a master data source, > > > reducing bugs. Adding new QKeyCodes will now only require the > > > master table to be updated, all ~20 other tables will be > > > automatically updated to follow. > > > > > > Signed-off-by: Daniel P. Berrange <berrange@redhat.com> > > > --- > > > .gitignore | 2 ++ > > > .gitmodules | 3 +++ > > > configure | 2 ++ > > > tests/docker/Makefile.include | 11 +++++++---- > > > tests/docker/run | 4 +++- > > > ui/Makefile.objs | 18 ++++++++++++++++++ > > > ui/keycodemapdb | 1 + > > > 7 files changed, 36 insertions(+), 5 deletions(-) > > > create mode 160000 ui/keycodemapdb > > > > > > > > diff --git a/configure b/configure > > > index dd73cce62f..bd373ec2b4 100755 > > > --- a/configure > > > +++ b/configure > > > @@ -5258,6 +5258,8 @@ echo_version() { > > > fi > > > } > > > > > > +(cd $source_path && git submodule update --init ui/keycodemapdb) > > > + > > > > Urgh, no, this won't work because of course you don't have to > > have a git checkout when running configure. > > > > Any suggestions on the "best" way to ensure that the ui/keycodemapdb > > git submodule is always checked out, without requiring developers to > > do something manually ? > > > > I could try > > > > (cd $source_path && test -d .git && git submodule update --init ui/keycodemapdb) > > > > but wonder if there's a better way ? > > I think the way dtc handles this is okay: probe headers/libs, if failed, hint > the "git submodule update" command in the error message. This is also a > familiar/friendly user interface to developers. I don't think that's acceptable in this case. Few people will ever need to setup the dtc submodule as distros commonly have that available. For the keycodemapdb *EVERY* single person who builds QEMU from git will need it, and they'll also need to update it periodically when the submodule hash changes. So we need to have it automated IMHO. > (If you looks at the test snippet that patchew runs, there is an explicit > submodule command: > > #!/bin/bash > set -e > git submodule update --init dtc > # Let docker tests dump environment info > export SHOW_ENV=1 > export J=8 > time make docker-test-quick@centos6 > time make docker-test-build@min-glib > time make docker-test-mingw@fedora > > as the libfdt devel package is not available in every docker images.) IMHO that is a bad approach because someone typing 'make docker-test-mingw@fedora' is going to be missing the dtc module. You'll see in this case I extended the docker/Makefile to always pull in keycodemapdb, not rely on someone remembering todo it manually. Regards, Daniel
On Tue, 08/15 11:53, Daniel P. Berrange wrote: > On Tue, Aug 15, 2017 at 06:47:22PM +0800, Fam Zheng wrote: > > On Tue, 08/15 11:04, Daniel P. Berrange wrote: > > > On Tue, Aug 15, 2017 at 10:36:04AM +0100, Daniel P. Berrange wrote: > > > > The https://gitlab.com/keycodemap/keycodemapdb/ repo contains a > > > > data file mapping between all the different scancode/keycode/keysym > > > > sets that are known, and a tool to auto-generate lookup tables for > > > > different combinations. > > > > > > > > It is used by GTK-VNC, SPICE-GTK and libvirt for mapping keys. > > > > Using it in QEMU will let us replace many hand written lookup > > > > tables with auto-generated tables from a master data source, > > > > reducing bugs. Adding new QKeyCodes will now only require the > > > > master table to be updated, all ~20 other tables will be > > > > automatically updated to follow. > > > > > > > > Signed-off-by: Daniel P. Berrange <berrange@redhat.com> > > > > --- > > > > .gitignore | 2 ++ > > > > .gitmodules | 3 +++ > > > > configure | 2 ++ > > > > tests/docker/Makefile.include | 11 +++++++---- > > > > tests/docker/run | 4 +++- > > > > ui/Makefile.objs | 18 ++++++++++++++++++ > > > > ui/keycodemapdb | 1 + > > > > 7 files changed, 36 insertions(+), 5 deletions(-) > > > > create mode 160000 ui/keycodemapdb > > > > > > > > > > > diff --git a/configure b/configure > > > > index dd73cce62f..bd373ec2b4 100755 > > > > --- a/configure > > > > +++ b/configure > > > > @@ -5258,6 +5258,8 @@ echo_version() { > > > > fi > > > > } > > > > > > > > +(cd $source_path && git submodule update --init ui/keycodemapdb) > > > > + > > > > > > Urgh, no, this won't work because of course you don't have to > > > have a git checkout when running configure. > > > > > > Any suggestions on the "best" way to ensure that the ui/keycodemapdb > > > git submodule is always checked out, without requiring developers to > > > do something manually ? > > > > > > I could try > > > > > > (cd $source_path && test -d .git && git submodule update --init ui/keycodemapdb) > > > > > > but wonder if there's a better way ? > > > > I think the way dtc handles this is okay: probe headers/libs, if failed, hint > > the "git submodule update" command in the error message. This is also a > > familiar/friendly user interface to developers. > > I don't think that's acceptable in this case. Few people will ever need > to setup the dtc submodule as distros commonly have that available. It's not available in the case of RHEL/CentOS 7, so it is similar in a degree which is why I mentioned it. But certainly I'll be happy to see a way to have this automated. FWIW I've no objection to the "test -d .git" idea. For docker tests to work, I'm inclined to change the Makefile rules so that every initialized submodule under $SRC_PATH is git-archived and copied in. Fam
Hi, > > +(cd $source_path && git submodule update --init ui/keycodemapdb) > > + > > Urgh, no, this won't work because of course you don't have to > have a git checkout when running configure. > > Any suggestions on the "best" way to ensure that the ui/keycodemapdb > git submodule is always checked out, without requiring developers to > do something manually ? Don't require it? The updates shouldn't happen that frequently, IMO we should just commit the generated files so checking out the submodule is only needed if you work on the keycodemaps. cheers, Gerd
On Wed, Aug 23, 2017 at 04:45:36PM +0200, Gerd Hoffmann wrote: > Hi, > > > > +(cd $source_path && git submodule update --init ui/keycodemapdb) > > > + > > > > Urgh, no, this won't work because of course you don't have to > > have a git checkout when running configure. > > > > Any suggestions on the "best" way to ensure that the ui/keycodemapdb > > git submodule is always checked out, without requiring developers to > > do something manually ? > > Don't require it? > > The updates shouldn't happen that frequently, IMO we should just commit > the generated files so checking out the submodule is only needed if you > work on the keycodemaps. Ok, I guess that's simplest and matches what's done elsewhere in QEMU Regards, Daniel
diff --git a/.gitignore b/.gitignore index cf65316863..6e5a1202c8 100644 --- a/.gitignore +++ b/.gitignore @@ -14,6 +14,8 @@ /trace/generated-tcg-tracers.h /ui/shader/texture-blit-frag.h /ui/shader/texture-blit-vert.h +/ui/keycodemap_*.c +/ui/input-keymap-*.c *-timestamp /*-softmmu /*-darwin-user diff --git a/.gitmodules b/.gitmodules index 5b0c212622..369989f19e 100644 --- a/.gitmodules +++ b/.gitmodules @@ -37,3 +37,6 @@ [submodule "roms/QemuMacDrivers"] path = roms/QemuMacDrivers url = git://git.qemu.org/QemuMacDrivers.git +[submodule "ui/keycodemapdb"] + path = ui/keycodemapdb + url = https://gitlab.com/keycodemap/keycodemapdb.git diff --git a/configure b/configure index dd73cce62f..bd373ec2b4 100755 --- a/configure +++ b/configure @@ -5258,6 +5258,8 @@ echo_version() { fi } +(cd $source_path && git submodule update --init ui/keycodemapdb) + # prepend pixman and ftd flags after all config tests are done QEMU_CFLAGS="$pixman_cflags $fdt_cflags $QEMU_CFLAGS" libs_softmmu="$pixman_libs $libs_softmmu" diff --git a/tests/docker/Makefile.include b/tests/docker/Makefile.include index aaab1a4208..2920edb79a 100644 --- a/tests/docker/Makefile.include +++ b/tests/docker/Makefile.include @@ -18,21 +18,24 @@ TESTS ?= % IMAGES ?= % # Make archive from git repo $1 to tar.gz $2 -make-archive-maybe = $(if $(wildcard $1/*), \ - $(call quiet-command, \ +make-archive = $(call quiet-command, \ (cd $1; if git diff-index --quiet HEAD -- &>/dev/null; then \ git archive -1 HEAD --format=tar.gz; \ else \ git archive -1 $$(git stash create) --format=tar.gz; \ fi) > $2, \ - "ARCHIVE","$(notdir $2)")) + "ARCHIVE","$(notdir $2)") +make-archive-maybe = $(if $(wildcard $1/*), \ + $(call make-archive, $1, $2)) CUR_TIME := $(shell date +%Y-%m-%d-%H.%M.%S.$$$$) DOCKER_SRC_COPY := docker-src.$(CUR_TIME) $(DOCKER_SRC_COPY): @mkdir $@ - $(call make-archive-maybe, $(SRC_PATH), $@/qemu.tgz) + $(call quiet-command, git submodule update --init $(SRC_PATH)/ui/keycodemapdb, "GIT", "ui/keycodemapdb") + $(call make-archive, $(SRC_PATH), $@/qemu.tgz) + $(call make-archive, $(SRC_PATH)/ui/keycodemapdb, $@/keycodemapdb.tgz) $(call make-archive-maybe, $(SRC_PATH)/dtc, $@/dtc.tgz) $(call make-archive-maybe, $(SRC_PATH)/pixman, $@/pixman.tgz) $(call quiet-command, cp $(SRC_PATH)/tests/docker/run $@/run, \ diff --git a/tests/docker/run b/tests/docker/run index c1e4513bce..c30352df4a 100755 --- a/tests/docker/run +++ b/tests/docker/run @@ -33,13 +33,15 @@ mkdir -p $TEST_DIR/{src,build,install} # Extract the source tarballs tar -C $TEST_DIR/src -xzf $BASE/qemu.tgz -for p in dtc pixman; do +for p in dtc pixman ; do if test -f $BASE/$p.tgz; then tar -C $TEST_DIR/src/$p -xzf $BASE/$p.tgz export FEATURES="$FEATURES $p" fi done +tar -C $TEST_DIR/src/ui/keycodemapdb -xzf $BASE/keycodemapdb.tgz + if test -n "$SHOW_ENV"; then if test -f /packages.txt; then echo "Packages installed:" diff --git a/ui/Makefile.objs b/ui/Makefile.objs index 3369451285..6796a9f98b 100644 --- a/ui/Makefile.objs +++ b/ui/Makefile.objs @@ -49,3 +49,21 @@ gtk-egl.o-libs += $(OPENGL_LIBS) shader.o-libs += $(OPENGL_LIBS) console-gl.o-libs += $(OPENGL_LIBS) egl-helpers.o-libs += $(OPENGL_LIBS) + +KEYCODEMAP_GEN = $(SRC_PATH)/ui/keycodemapdb/tools/keymap-gen +KEYCODEMAP_CSV = $(SRC_PATH)/ui/keycodemapdb/data/keymaps.csv + +KEYCODEMAP_FILES = \ + $(NULL) + +GENERATED_FILES += $(KEYCODEMAP_FILES) + +ui/input-keymap-%.c: $(KEYCODEMAP_GEN) $(KEYCODEMAP_CSV) $(SRC_PATH)/ui/Makefile.objs + $(call quiet-command,\ + src=$$(echo $@ | sed -E -e "s,^ui/input-keymap-(.+)-to-(.+)\.c$$,\1,") && \ + dst=$$(echo $@ | sed -E -e "s,^ui/input-keymap-(.+)-to-(.+)\.c$$,\2,") && \ + $(PYTHON) $(KEYCODEMAP_GEN) \ + --lang glib2 \ + --varname qemu_input_map_$${src}_to_$${dst} \ + code-map $(KEYCODEMAP_CSV) $${src} $${dst} \ + > $@ || rm $@, "GEN", "$@") diff --git a/ui/keycodemapdb b/ui/keycodemapdb new file mode 160000 index 0000000000..56ce5650d2 --- /dev/null +++ b/ui/keycodemapdb @@ -0,0 +1 @@ +Subproject commit 56ce5650d2c6ea216b4580df44b9a6dd3bc92c3b
The https://gitlab.com/keycodemap/keycodemapdb/ repo contains a data file mapping between all the different scancode/keycode/keysym sets that are known, and a tool to auto-generate lookup tables for different combinations. It is used by GTK-VNC, SPICE-GTK and libvirt for mapping keys. Using it in QEMU will let us replace many hand written lookup tables with auto-generated tables from a master data source, reducing bugs. Adding new QKeyCodes will now only require the master table to be updated, all ~20 other tables will be automatically updated to follow. Signed-off-by: Daniel P. Berrange <berrange@redhat.com> --- .gitignore | 2 ++ .gitmodules | 3 +++ configure | 2 ++ tests/docker/Makefile.include | 11 +++++++---- tests/docker/run | 4 +++- ui/Makefile.objs | 18 ++++++++++++++++++ ui/keycodemapdb | 1 + 7 files changed, 36 insertions(+), 5 deletions(-) create mode 160000 ui/keycodemapdb